Interactions Report for Version: V01R04.3 (CeRx)
Interactions Table of Contents
Package Locations Table of Contents
|
|---|
|
|
|
|
|---|
| Add patient note request accepted |
|---|
Indicates that the specified annotation has been successfully recorded against the requested patient. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Add patient note request refused |
|---|
Indicates that the request to record the annotation against a particular patient has been denied. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Deprecate patient note request accepted |
|---|
Indicates that the specified patient annotation has been successfully marked as no longer applicable. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Deprecate patient note request refused |
|---|
Indicates that the request to mark the specified patient annotation as no longer applicable has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Patient note query |
|---|
Requests retrieval of the notes that have been recorded against a particular patient, potentially filtered by note type and/or date. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Add note to record request accepted |
|---|
Indicates that the specified annotation has been successfully recorded against the requested record. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Add note to record request refused |
|---|
Indicates that the request to record the annotation against a particular record has been denied. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Change item masking request |
|---|
Requests that an identified item, group of items (identified by act type, medication, indication) or all items for a particular patient should have their confidentiality code changed to the specified value. | | Message<ControlActEvent<MaskableActType>> |
|
|
|
|
|---|
| Change item masking request accepted |
|---|
Indicates that the confidentiality code has been successfully revised for the requested identified item, group of items (identified by act type, medication, indication) or all items for a particular patient. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Change item masking request refused |
|---|
Indicates that the requested confidentiality code change has been denied. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Broadcast Message |
|---|
Sends a broadcast message to all or a subset of users of a given system; (Used for alerts regarding system outages or other urgent messages). | | Message<ControlActEvent<InformEvent>> |
|
|
|
|
|---|
| Retract action request |
|---|
Seeks to have an identified ControlAct nullified, essentially reversing the record of the event. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Retract action request accepted |
|---|
Indicates that an identified ControlAct has been nullified as requested, essentially reversing the record of the event. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Retract action request refused |
|---|
Indicates that the request to nullify an identified ControlAct has been denied, leaving the original event in force. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Add issue management request accepted |
|---|
Indicates that the specified issue has been successfully updated to include the identified management(s). | | Message<ControlActEvent> |
|
|
|
|
|---|
| Add issue management request refused |
|---|
Indicates that the request to update an issue with identified management(s) has been denied. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Send Poll Transmission |
|---|
Sends HL7 Poll Transmission to an HL7 interaction queue manager. | | Message |
|
|
|
|
|---|
| Request Poll Queue Status |
|---|
Requests an indication of the number and priority of outstanding interactions (if any) on the application's poll queue. | | Message |
|
|
|
|
|---|
| Return Poll Queue Status |
|---|
Returns an indication of the number and priority of outstanding interactions (if any) on the application's poll queue. | | Message |
|
|
|
|
|---|
|
|
|
|
|---|
| Record immunization request accepted |
|---|
Indicates that the requested immunization information has been successfully added to the patient's record. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record immunization request refused |
|---|
Indicates that the request to add an immunization to the patient record has been denied. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
| Update immunization request accepted |
|---|
Indicates that information about a change to a previously recorded immunization has been successfully recorded. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Update immunization request refused |
|---|
Indicates that the request to record a change to information about a previously recorded immunization has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Retract immunization request |
|---|
Asks that a previously recorded immunization should be ""removed"" from the record; (Information may be retained for audit purposes). | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Retract immunization request accepted |
|---|
Indicates that a previously recorded immunization has been ""removed"" from the record as requested; (Information may have been retained for audit purposes). | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Retract immunization request refused |
|---|
Indicates that the requested previously recorded immunization will not be ""removed"" from the record; | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Immunizations query |
|---|
Requests retrieval of detailed information about a patient's immunizations, potentially filtered by time-range of the immunization, time-range the immunization was last updated, and/or type of immunization. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Drug document query |
|---|
Requests retrieval of a specific monograph or set of monographs for a particular medication (specified by identifier) or indication. The type of monograph (provider, patient, long, short, etc.) may be specified. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Drug search query |
|---|
Requests retrieval of a lists of candidate drugs based on various search criteria such as name, route, code, manufacturer, appearance, etc. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Record refusal to dispense request |
|---|
Requests that the specified ""refusal to fill"" note be recorded against the identified prescription. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record refusal to dispense request accepted |
|---|
Indicates that the requested ""refusal to fill"" note has been recorded against the identified prescription. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record refusal to dispense request refused |
|---|
Indicates that the request to record a ""refusal to fill"" against a prescription has been refused. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Revise assigned dispense responsibility notif. |
|---|
Indicates that the responsibility for fulfilling the dispense portion of a prescription has changed. | | Message<ControlActEvent<SupplyRequest>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Revise assigned dispense responsibility req. acc. |
|---|
Indicates that the responsibility for fulfilling the dispense portion of a prescription has been changed to the requested facility. | | Message<ControlActEvent<Prescription>> |
|
|
|
|
|---|
| Revise assigned dispense responsibility req. ref. |
|---|
Indicates that the request to change the facility responsible for fulfilling the dispense portion of a prescription has been refused. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Activate prescription request accepted |
|---|
Indicates that a medication prescription has been recorded against the patient's record as requested. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Activate prescription request refused |
|---|
Indicates that the request to record a medication prescription against the patient's record as been refused. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Abort dispense authorization request |
|---|
Requests that a prescription be marked as ""no longer dispensable but still administrable"". | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Abort dispense authorization request accepted |
|---|
Indicates that the requests prescription has been marked as ""no longer dispensable but still administrable"". | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Abort dispense authorization request refused |
|---|
Indicates that the request to mark a prescription as ""no longer dispensable but still administrable"" has been refused. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Prescription clinical pre-determination not ok |
|---|
Indicates that the specified medication prescription proposal was reviewed and no issues were detected. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Prescription clinical pre-determination ok |
|---|
Indicates that the specified issues were found in reviewing the requested medication prescription proposal. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Prescription fulfillment request (no resp.) |
|---|
Requests that the specified facility dispense the medication prescription transmitted by this interaction and does not expect a response interaction | | Message<ControlActEvent<CombinedMedicationRequest>> |
|
|
|
|
|---|
| Prescription renewal request |
|---|
Requests that a prescriber issue a renewal prescription based on a previously existing prescription. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Prescription renewal request accepted |
|---|
Indicates that the requested prescription has been renewed by a new prescription, referenced by identifier. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Prescription renewal request refused |
|---|
Indicates that the request for the issuance of a prescription has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Abort prescription request |
|---|
Requests that the specified prescription be aborted (further dispensing or administrative must cease). | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Abort prescription request accepted |
|---|
Indicates that the requested prescription has been aborted (further dispensing or administrative must cease) | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Device prescr. fulfill request (no resp.) |
|---|
Requests that the specified facility dispense the device prescription transmitted by this interaction and does not expect a response interaction | | Message<ControlActEvent<DeviceRequest>> |
|
|
|
|
|---|
| Activate device prescription request accepted |
|---|
Indicates that a device prescription has been recorded against the patient's record as requested. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Activate device prescription request refused |
|---|
Indicates that the request to record a device prescription against the patient's record as been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Record device dispense processing request |
|---|
Requests that the device dispense processing (drug preparation, packaging and contraindication checking) for a particular quantity of devices against a prescription has been performed and the medication is awaiting pickup ne recorded. | | Message<ControlActEvent<DeviceDispense>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record dispense pickup request refused |
|---|
Indicates that the request to record the pickup of the specified prescription has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record dispense processing request accepted |
|---|
Indicates that the requested medication dispense processing information has been successfully recorded in the patient's record. | | Message<ControlActEvent<SupplyEvent>> |
|
|
|
|
|---|
| Record dispense processing request refused |
|---|
Indicates that the request to record the medication dispense processing has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record supply event (ward stock) request accept |
|---|
Indicates the requested bulk supply of a medication to a facility has been recorded. | | Message<ControlActEvent<SupplyEvent>> |
|
|
|
|
|---|
| Record supply event (ward stock) request refused |
|---|
Indicates that the request to record a bulk supply of a medication to a facility has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Device dispense processing record request refused |
|---|
Indicates that the request to record the device dispense processing has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Record device disp. processing request accepted |
|---|
Indicates that the requested device dispense processing information has been successfully recorded in the patient's record. | | Message<ControlActEvent<SupplyEvent>> |
|
|
|
|
|---|
| Record dispense reversal request |
|---|
Requests that a previously submitted dispense be marked as reversed. The medication has been disposed of without having been picked up nor consumed by the patient. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record dispense reversal request accepted |
|---|
Indicates that the reversal of the prescription has been recorded as requested | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record dispense reversal request refused |
|---|
Indicates that the request to record the reversal of the specified prescription has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record other medication request refused |
|---|
Indicates that the request to add the medication has been denied. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
| Update other medication request accepted |
|---|
Indicates that the requested status, comments and/or other information about an existing medication record have been successfully modified. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Update other medication request refused |
|---|
Indicates that the request to update information about an existing medication record has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Drug contraindications query |
|---|
Requests retrieval of the contraindications associated with issuing a particular combination of drugs based only on a list of concomitant medications. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Drug regimen contraindications query response |
|---|
Indicates the contraindications (if any) associated with a set of medications. Only includes drug-drug and duplicate therapy contraindications because that's all that is deducible based on a list of medications. | | Message<ControlActEvent<DetectedIssueEvent, ParameterList>> |
|
|
|
|
|---|
| Patient drug contraindications query |
|---|
Requests retrieval of the potential contraindications associated with issuing a specified medication to a particular patient based on their existing medication and clinical profile. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Device prescr. with hist. and disp. query |
|---|
Requests retrieval of detailed information about a single identified device prescription, including history of changes and all fulfilling dispense events. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Device prescription dispense summary query |
|---|
Requests retrieval of basic information about all device dispenses provided to a particular patient, potentially filtered by date. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Device prescription detail query |
|---|
Requests retrieval of detailed information about a single device prescription referenced by id, optionally including detailed dispense information. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Device prescription fills query |
|---|
Requests retrieval of basic information about all dispenses performed against a particular device prescription referenced by id | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Device prescription summary query |
|---|
Requests retrieval of basic information about all device prescriptions provided to a single patient, optionally filtered by date and status. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Med. prescr. with hist. and dispenses query |
|---|
Requests retrieval of detailed information about a single identified medication prescription, including history of changes and all fulfilling dispense events | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Medication dispense summary query |
|---|
Requests basic information about all medication dispenses provided to a particular patient, potentially filtered by date. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Medication prescription detail query |
|---|
Requests retrieval of detailed information about a single medication prescription referenced by id, optionally including detailed dispense information. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Medication prescription fills query |
|---|
Requests retrieval of basic information about all medication dispenses performed against a particular prescription referenced by id | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Medication prescription summary query |
|---|
Requests retrieval of basic information about all medication prescriptions provided to a single patient, optionally filtered by date and status. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Medication profile detail generic query |
|---|
Requests retrieval of detailed information about a patient's prescriptions, dispenses and other medications for a specific patient filtered by a variety of criteria, including id, drug, indication, date, etc. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Medication profile detail generic query resp. |
|---|
Returns detailed information about a patient's prescriptions, dispenses and other medications for a specific patient filtered by a variety of criteria, including id, drug, indication, date, etc. | | Message<ControlActEvent<MedicationRecord, ParameterList>> |
|
|
|
|
|---|
| Medication profile detail query |
|---|
Requests retrieval of detailed information about a patient's prescriptions, dispenses and other medications for a specific patient optionally filtered by date. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Medication profile summary query |
|---|
Requests retrieval of basic information about a patient's prescriptions, dispenses and other medications for a specific patient optionally filtered by date. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Other medication detail query |
|---|
Requests retrieval of detailed information about a single ""other medication"" record, referenced by identifier. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Unfilled prescr. by prescriber query |
|---|
Requests retrieval of basic information about all prescriptions provided to a single patient, prescribed by the specified prescriber which have not yet been dispensed, optionally filtered by date and status. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Unfilled prescr. by prescriber query response |
|---|
Returns basic information about all prescriptions provided to a single patient, prescribed by the specified prescriber which have not yet been dispensed, optionally filtered by date and status. | | Message<ControlActEvent<Prescription, ParameterList>> |
|
|
|
|
|---|
| Unfilled prescriptions query |
|---|
Requests retrieval of basic information about all prescriptions provided to a single patient which have not yet been dispensed, optionally filtered by date and status. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Unfilled prescriptions query response |
|---|
Returns basic information about all prescriptions provided to a single patient which have not yet been dispensed, optionally filtered by date and status. | | Message<ControlActEvent<Prescription, ParameterList>> |
|
|
|
|
|---|
| Record consent or override request accepted |
|---|
Indicates that the requested consent, revocation of consent or consent override has been successfully recorded for a particular patient. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record consent or override request refused |
|---|
Indicates that the request to record a consent, revocation of consent or consent override has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Record consent or override request |
|---|
Requests that a consent, revocation of consent or consent override be recorded for a particular patient. | | Message<ControlActEvent<ConsentEvent>> |
|
|
|
|
|---|
| Update keyword request accepted |
|---|
Indicates that the keyword used to control patient access to a all or a portion of the patient's record has been successfully revised to the requested value. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Update keyword request refused |
|---|
Indicates that the request to revise the patient's keyword has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Update keyword request |
|---|
Requests that the keyword used to control patient access to a all or a portion of the patient's record be revised to the specified value. | | Message<ControlActEvent<KeywordEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record adverse reaction request accepted |
|---|
Indicates that the requested adverse reaction information has been successfully recorded against the patient. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record adverse reaction request refused |
|---|
Indicates that the request to record the specified reaction against the patient's record has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
| Update adverse reaction request accepted |
|---|
Indicates that the requested severity, outcome, suspected cause or other information about a previously-recorded adverse reaction has been successfully updated. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Update adverse reaction request refused |
|---|
Indicates that the requested modification to the previously-recorded adverse reaction has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Add allergy/intolerance request accepted |
|---|
Indicates that the requested allergy or intolerance record has been successfully added to the patient's record. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Add allergy/intolerance request refused |
|---|
Indicates that the request to add the specified allergy or intolerance to the patient record has been denied. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Patient allergy/intolerance query |
|---|
Requests retrieval of all allergies or intolerances that have been recorded for a particular patient, optionally filtered by time-range when the allergy or intolerance record has last been changed. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Patient allergy/intolerance with hist. query |
|---|
Requests retrieval of the history of a particular allergy or intolerance record identified by patient id and allergy or intolerance record id, including changes to severity, status, annotations, etc. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Update allergy/intolerance request accepted |
|---|
Indicates that the status, severity and/or other information about the requested allergy or intolerance record has been updated. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Update allergy/intolerance request refused |
|---|
Indicates that the requested modification to the defined allergy or intolerance record has been denied. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Patient medical condition with hist. query |
|---|
Requests retrieval of the history of a particular medical condition record identified by patient id and medical condition record id, including changes to severity, status, start date, end date, etc. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record medical condition request accepted |
|---|
Indicates that the requested medical condition record has been successfully added to the patient's record. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record medical condition request refused |
|---|
Indicates that the request to add the specified medical condition to the patient record has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Update medical condition request |
|---|
Requests that information such as severity, status, start date and end date of a previously-recorded medical condition be updated. | | Message<ControlActEvent<MedicalCondition>> |
|
|
|
|
|---|
| Update medical condition request accepted |
|---|
Indicates that the requested severity, status, start date, end date or other information about a previously-recorded medical condition has been successfully updated. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Update medical condition request refused |
|---|
Indicates that the requested modification to the previously-recorded medical condition has been refused. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record pharmacy prof. service request |
|---|
Seeks to add a record of a professional service (training, counseling, medication reviews, etc.) which has been delivered to a patient. | | Message<ControlActEvent<ProcedureEvent>> |
|
|
|
|
|---|
| Record pharmacy prof. service request accepted |
|---|
Indicates that a record of a professional service (training, counseling, medication reviews, etc.) which has been delivered to a patient has been successfully added. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record pharmacy prof. service request refused |
|---|
Indicates that the request to add a record of a professional service (training, counseling, medication reviews, etc.) which has been delivered to a patient has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
| Record patient basic observation request accepted |
|---|
Indicates that the requested basic observation (height, weight, blood-pressure, etc.) has been successfully recorded in a patient's record. | | Message<ControlActEvent<ActEvent>> |
|
|
|
|
|---|
| Record patient basic observation request refused |
|---|
Indicates that the request to record the specified observation in the patient's record has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Patient basic observations query |
|---|
Requests retrieval of the basic observations (height, weight, blood-pressure, etc.) which have been recorded for a particular patient, optionally filtered by the type of observation and/or by the date-range for which the observation was recorded. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| COCT_MT040205CA.Person |
|---|
classCode :   "PSN"  (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: A:Responsible Person Name The name by which the responsible person is known Used when contacting or addressing the responsible person. Because this will be the principle means of identifying the responsible person, it is mandatory. ZPB3.13 PVD.050-01 (PartType = Family) PVD.050-02 (PartType = Given - 1st rep) PVD.050-03 PartType = Given - any rep other than the first) PVD.050-04 (PartType = Suffix) PVD.050-05 (PartType = Prefix) PVD.100-01 (PartType = Family; author/performer when supervisor is also specified) PVD.100-02 (PartType = Given - 1st rep; author/performer when supervisor is also specified ) PVD.100-03 PartType = Given - any rep other than the first; author/performer when supervisor is also specified) PVD.100-04 (PartType = Suffix; author/performer when supervisor is also specified) PVD.100-05 (PartType = Prefix; author/performer when supervisor is also specified) D1a Practitioner's Name 04.03 Prescriber.427-DR Prescribing Physician Name ZPS.18.3 ZPS.18.4 ZPS.18.5 ZPS.19.3 ZPS.19.4 ZPS.19.5 ZPS.10.3 ZPS.10.4 ZPS.10.5 ProviderPreviewInfo.ProviderName | 1 | Mand |
| COCT_MT040205CA.ResponsibleParty Business name: Responsible Person Describes a person (other than a health-care provider or patient) who is providing information and making decision on behalf of the patient, in relation to the delivery of healthcare for the patient. E.g. Patient's mother. Important for tracking source of information for decision making and other actions taken on behalf of a patient. |
|---|
| classCode : "AGNT" (RoleClass) | 1 | Mand | id : II Business name: B:Responsible Person ID A unique identifier for the responsible person. Allows a person to be uniquely referred to. ZPB1.6 (Root) ZPB1.7 (EXtension) ZPB2.8 (Root) ZPB2.9 (EXtension) ZPB3.11 (Root) ZPB3.12 (EXtension) ZPB3.18 (Root) ZPB3.19 (EXtension) D60 (Root) D61 (Extension) D76 PVD.020-01 (Extension) PVD.020-02 (Root) PharmacyProvider.444-E9 (Extension) PharmacyProvider.465-E7 (Root) Prescriber.446-EZ (Extension) PharmacyProvider.411-DB (Root) ZDP.18.1 (Extension) ZDP.18.2 (Root) ZDP.19.1 (Extension) ZDP.19.2 (Root) ZDP.10.1 (Extension) ZDP.10.2 (Root) Provider.PproviderExternalKey (Extension) Provider.providerKey (Extension) Provider.wellnetProviderId (Extension) ProviderRegistration.Identifier (Extension) ProviderRegistration.IdentifierDomain (part of Extension) ProviderRegistrationjurisdiction (part of Extension) | 0-1 | Req | code :  (x_SimplePersonalRelationship) Business name: C:Responsible Person Type A coded value indicating how the responsible person is related to the person for whom they have accepted responsibility. May be important for understanding the authority to perform certain actions. E.g. A 'friend' may not be able to make consent decisions, but may be able to pick up dispenses. | 0-1 | Req | addr : AD.BASIC Business name: D:Responsible Person Address The mail and/or physical address associated with a responsible person. Used to contact the responsible person. PVD.080-01 (PartType=SAL) PVD.080-02 (PartType=CTY) PVD.080-03 (PartType=CNT) PVD.080-04 (PartType=ZIP) D.1b Shipping Address (PartType=SAL) City PartType=CTY) Province (PartType=STA) Postal Code (PartType=ZIP) Send care of(PartType=CARE) | 0-1 | Req | telecom : SET<TEL.PHONEMAIL> Business name: E:Responsible Person Phones and Emails The phone number(s) and email address(s) by which a responsible person may be contacted. Used to contact the responsible person. PVD.090-01 (url) PVD.090-02 (url.scheme) PVD.090-01 (use) D.1c Tell # Fax # Contact Tel # Contact Fax # Prescriber.498-PM Prescroibing Physician Phone Number | 0-5 | Req | | agentPerson : Person | 1 | Mand |
|
|
|
|
|---|
COCT_MT050202CA.Patient Business name: Patient A person who is receiving or may receive healthcare services and has personal attributes (e.g. name, birth date). . Information used to identify the patient and to support clinical decisions. This information applies to the person in the context of the associated action only, and should be stored separately. I.e. the address/phone/email only apply to the current prescription/dispense/lab order etc. |
|---|
| classCode : "PAT" (RoleClass) | 1 | Mand | id : II Business name: A:Patient ID Unique identifier assigned to a person by Federal, Provincial and Territorial jurisdiction for the purposes of uniquely identifying the person within the EHR. The EHR will define which identifier to use within a jurisdiction. Allows a patient to be referred to unambiguously. Because this is the principal mechanism for identifying humans, the attribute is mandatory. If an identifier is not known, it should be looked up using the 'client registry' capabilities of the EHR application. C39 (Extension) PTT.050.01 (Extension) PTT.050.02 (Root) A.1 PID.2 Patient.332-CY (Extension) Patient.331-CX (Root) Claim.330-CW Health Card Number PID.2 PID.4 ZDU.2 ZKW.3 Jurisdiction (Root) Person.PHN (Extension) | 1 | Mand | | patientPerson : Person | 1 | Mand |
| | COCT_MT050202CA.Person |
|---|
| classCode : "PSN" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC Business name: B:Patient Name The name by which the patient is known and which apply to a particular clinical action that has been reported or recorded. Used, with other patient identity attributes, to confirm patient identity, as well as when addressing the patient. Element is mandatory because the patient's name is necessary for positive identification of the patient in the jurisdictional client registry. ZPA.1 (partType=Given) ZPA.2 (partType=Family) ZPA.3 (partType=Given - all repetitions except first) C37 (partType=Given) C38 (partType=Family) PTT.030-01 (partType=Family) PTT.030-02 (partType=Given - 1st occurrence) PTT.030-03 (partType=Given - subsequen occurrences) PTT.030-04 (partType=Suffix) PTT.030-05 (partType=Prefix) patient Initials PID.5 Patient.310-CA (partType=Given) Patient.311-CB (partType=Family) Recipient Name First (partType=Given) Recipient Name Last (partType=Family) PID.5 PID.9 (any name other than first repetition is an alias) ZDU.3 ZKW.2 Person.givenName Person.lastName Person.middleName Person.namePrefix Person.nameSuffix | 1 | Mand | administrativeGenderCode : (AdministrativeGender) Business name: F:Patient Gender Indicates the gender (sex) of the patient. Complex genetic genders are handled as observations if they are considered relevant. Used to confirm patient identity. May affect dosing or therapy appropriateness. Element is mandatory because the patient's gender is necessary for positive identification of the patient in the jurisdictional client registry. | 1 | Mand | birthTime : TS.DATE Business name: E:Patient Birth Date Indicates the date on which the patient was born. Used to confirm patient identity. May also influence dosage and therapy appropriateness. Element is mandatory because the patient's birth date is necessary for positive identification of the patient in the jurisdictional client registry. | 1 | Mand |
|
|
|
|
|---|
COCT_MT050203CA.Patient Business name: Patient A person who is receiving or may receive healthcare services and has personal attributes (e.g. name, birth date). . Information used to identify the patient and to support clinical decisions. This information applies to the person in the context of the associated action only, and should be stored separately. I.e. the address/phone/email only apply to the current prescription/dispense/lab order etc. |
|---|
| classCode : "PAT" (RoleClass) | 1 | Mand | id : II Business name: A:Patient ID Unique identifier assigned to a person by Federal, Provincial and Territorial jurisdiction for the purposes of uniquely identifying the person within the EHR. The EHR will define which identifier to use within a jurisdiction. Allows a patient to be referred to unambiguously. Because this is the principal mechanism for identifying humans, the attribute is mandatory. If an identifier is not known, it should be looked up using the 'client registry' capabilities of the EHR application. C39 (Extension) PTT.050.01 (Extension) PTT.050.02 (Root) A.1 PID.2 Patient.332-CY (Extension) Patient.331-CX (Root) Claim.330-CW Health Card Number PID.2 PID.4 ZDU.2 ZKW.3 Jurisdiction (Root) Person.PHN (Extension) | 1 | Mand | addr : AD.BASIC Business name: C:Patient Contact Address Physical address for the patient where they may be visited or found for the purposes of this particular action. Generally only specified when different from the addresses stored on the client registry. E.g. address on a prescription issued when a patient is temporary staying away from home. Can be used to record a temporary address used for the purposes of this prescription. Not intended for use to confirm patient identity. ZPA2.1 (use) ZPA2.2 (usablePeriod(IVL<TS).low) ZPA2.4 (partType=UNID) ZPA2.5 (DMODID - following DMOD=P.P.Box) ZPA2.6 (partType=??) ZPA2.7 (partType=??) ZPA2.8 (partType=CTY) ZPA2.9 (partType=CNT - populate mnemonic of SC) ZPA2.10 (partType=ZIP) ZPA2.11 (partType=SINST=PST) ZPA2.12 (partTYpe=STA) ZPA2.13 (partType=DMODID-followingDMOD=RR) ZPA2.14 (partType=DIR) ZPA2.15 (partType=STB) ZPA2.16 (partType=BNR) BC:ZPA2.17 (partType=STTYP) ZPA2.18 (usablePeriod (IVL<TS).high) ZPA2.19 (Line demarked by carriage return) PTT.060-01 (partType=SAL) PTT.060-02 (partType=CTY) PTT.060-03 (partType=CNT) PTT.060-04 (partType=ZIP) PID.11 Patient.322-CM (partType=SAL) Patient.323-CN (partType=CTY) Patient.324-CO (partType=STA) Patient.325-CP (partType=ZIP) PID.11 | 0-1 | Req | telecom : LIST<TEL.PHONEMAIL> Business name: D:Patient Contact Phone and E-mails Telephone, fax or e-mail addresses intended as the principal means of contact for the patient with regard to the current action. E.g. the phone number to reach the patient at regarding the results of an ordered test. On a prescription, this enables the communication of patient contact information to the dispenser for the specific prescription. This can be a phone/fax number and/or email address Can be used to record a temporary contact mechanism (phone, email) for the purposes of this action. Not intended for use to confirm patient identity. Important for following up with patient but not always available, and therefore only marked as 'populated'. ZPA1.1 (Use and/or URL.scheme) ZPA1.2 (usablePeriod (IVL<TS>).low) BC:ZPA1.3 (url.address - as per RFC2396) ZPA1.4 (url.address - as per RFC2396) ZPA1.5 (usablePeriod (IVL<TS>).high) PTT.070-01 PTT.070-02 D99.03 (url.address - as per RFC2396) patient.326-CQ PID.13 PID.14 | 1-5 | Pop | | patientPerson : Person | 1 | Mand |
| | COCT_MT050203CA.Person |
|---|
| classCode : "PSN" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC Business name: B:Patient Name The name by which the patient is known and which apply to a particular clinical action being reported or recorded. For a prescription, this will be the name traditionally printed on the paper script or the name that appears on the patient's chart. Used, with other patient identity attributes, to confirm patient identity, as well as when addressing the patient. Element is mandatory because the patient's name is necessary for positive identification of the patient in the jurisdictional client registry. ZPA.1 (partType=Given) ZPA.2 (partType=Family) ZPA.3 (partType=Given - all repetitions except first) C37 (partType=Given) C38 (partType=Family) PTT.030-01 (partType=Family) PTT.030-02 (partType=Given - 1st occurrence) PTT.030-03 (partType=Given - subsequen occurrences) PTT.030-04 (partType=Suffix) PTT.030-05 (partType=Prefix) patient Initials PID.5 Patient.310-CA (partType=Given) Patient.311-CB (partType=Family) Recipient Name First (partType=Given) Recipient Name Last (partType=Family) PID.5 PID.9 (any name other than first repetition is an alias) ZDU.3 ZKW.2 Person.givenName Person.lastName Person.middleName Person.namePrefix Person.nameSuffix | 1 | Mand | administrativeGenderCode : (AdministrativeGender) Business name: F:Patient Gender Indicates the gender (sex) of the patient. Complex genetic genders are handled as observations if they are considered relevant. Used to confirm patient identity. May affect dosing or therapy appropriateness. Element is mandatory because the patient's gender is necessary for positive identification of the patient in the jurisdictional client registry. C40 eScript:PTT.040 3 Sex PID.8 Patient.305-C5 PID.8 | 1 | Mand | birthTime : TS.DATE Business name: E:Patient Birth Date Indicates the date on which the patient was born. Used to confirm patient identity. May also influence dosage and therapy appropriateness. Element is mandatory because the patient's birth date is necessary for positive identification of the patient in the jurisdictional client registry. C34 PTT.020 A.2b HC-SA PID.7 patient.304-C4 PID.7 | 1 | Mand |
|
|
|
|
|---|
| COCT_MT050303CA.Animal |
|---|
| classCode : "ANM" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: B:Animal name Name by which the animal patient is known. Used, with other patient identity attributes, to confirm patient identity, as well as when addressing the patient. For animals, name is the primary identifier, and is therefore mandatory. ZPA.1 (partType=Given) ZPA.2 (partType=Family) ZPA.3 (partType=Given - all repetitions except first) C37 (partType=Given) C38 (partType=Family) PTT.030-01 (partType=Family) PTT.030-02 (partType=Given - 1st occurrence) PTT.030-03 (partType=Given - subsequen occurrences) PTT.030-04 (partType=Suffix) PTT.030-05 (partType=Prefix) patient Initials PID.5 Patient.310-CA (partType=Given) Patient.311-CB (partType=Family) Recipient Name First (partType=Given) Recipient Name Last (partType=Family) PID.5 PID.9 (any name other than first repetition is an alias) ZDU.3 ZKW.2 Person.givenName Person.lastName Person.middleName Person.namePrefix Person.nameSuffix | 1 | Mand | | contactParty : ContactParty | 1 | Mand |
| |
| COCT_MT050303CA.Patient Business name: Animal Patient An animal that is receiving or may receive healthcare services. Used when animal services are attached to a human patient record. E.g. narcotics prescribed for a pet may be attached to the owner's record for monitoring of abuse. |
|---|
| classCode : "PAT" (RoleClass) | 1 | Mand | | patientAnimal : Animal | 1 | Mand |
|
|
|
|
|---|
COCT_MT090107CA.AssignedPerson Business name: Provider Describes a healthcare provider involved in the delivery of healthcare services. Encompasses both professional and non-professional members. Important for tracking responsibility for healthcare events, as well as for identifying appropriate individuals to contact for further information or follow-up. While an important piece of identifying information, not all providers will have identifiers, thus this attribute is only 'populated'. |
|---|
| classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II Business name: A:Provider Id A unique identifier for a provider (e.g. the Prescriber on a new prescription). Allows a provider to be uniquely referred to but will not always be known and is therefore 'populated'. ZPB1.6 (Root) ZPB1.7 (EXtension) ZPB2.8 (Root) ZPB2.9 (EXtension) ZPB3.11 (Root) ZPB3.12 (EXtension) ZPB3.18 (Root) ZPB3.19 (EXtension) D60 (Root) D61 (Extension) D76 PVD.020-01 (Extension) PVD.020-02 (Root) PharmacyProvider.444-E9 (Extension) PharmacyProvider.465-E7 (Root) Prescriber.446-EZ (Extension) PharmacyProvider.411-DB (Root) ZDP.18.1 (Extension) ZDP.18.2 (Root) ZDP.19.1 (Extension) ZDP.19.2 (Root) ZDP.10.1 (Extension) ZDP.10.2 (Root) Provider.PproviderExternalKey (Extension) Provider.providerKey (Extension) Provider.wellnetProviderId (Extension) ProviderRegistration.Identifier (Extension) ProviderRegistration.IdentifierDomain (part of Extension) ProviderRegistrationjurisdiction (part of Extension) | 1 | Pop | code : (HealthcareProviderRoleType) Business name: Provider Type A coded value indicating the professional category of a provider. This is usually the discipline of the provider (e.g. physician, pharmacist, dentist, etc). Necessary for ascertaining providers' ability/competence in providing different types of health services. | 0-1 | Req | | representedPerson : Person | 1 | Mand |
| COCT_MT090107CA.LicensedEntity Business name: has A legal permission to provide healthcare of a particular type in a particular jurisdiction. Important to evaluating permissions. |
|---|
| classCode : "LIC" (RoleClass) | 1 | Mand | id : II Business name: D:Provider License Number The identifier of a professional license issued to the provider by a licensing body. If a provider possesses multiple licenses, this is the license that applies to the current action. Allows providers to verify/ascertain authority for clinical services. License Number ZDP.18.6 ZDP.19.6 ZPS.10.6 | 1 | Mand |
|
| COCT_MT090107CA.Person |
|---|
| classCode : "PSN" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC Business name: B:Provider Name The name by which the provider is known (e.g. the Prescriber on a new prescription). Used when contacting the provider. Also used by others to recognize a provider and then evaluate the information provided by a particular provider. This is the one piece of provider information which should always be known and is therefore mandatory. ZPB3.13 PVD.050-01 (PartType = Family) PVD.050-02 (PartType = Given - 1st rep) PVD.050-03 PartType = Given - any rep other than the first) PVD.050-04 (PartType = Suffix) PVD.050-05 (PartType = Prefix) PVD.100-01 (PartType = Family; author/performer when supervisor is also specified) PVD.100-02 (PartType = Given - 1st rep; author/performer when supervisor is also specified ) PVD.100-03 PartType = Given - any rep other than the first; author/performer when supervisor is also specified) PVD.100-04 (PartType = Suffix; author/performer when supervisor is also specified) PVD.100-05 (PartType = Prefix; author/performer when supervisor is also specified) D1a Practitioner's Name 04.03 Prescriber.427-DR Prescribing Physician Name ZPS.18.3 ZPS.18.4 ZPS.18.5 ZPS.19.3 ZPS.19.4 ZPS.19.5 ZPS.10.3 ZPS.10.4 ZPS.10.5 ProviderPreviewInfo.ProviderName | 1 | Mand | | asLicensedEntity : LicensedEntity | 0-1 | Req |
|
|
|
|
|---|
COCT_MT090302CA.AssignedDevice Business name: Application An identification of a system/application that can initiate an event to change the status of an object. Allows an application to be uniquely identified. |
|---|
| classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II Business name: C:Application Id Unique identifier of an application or a system. To uniquely identify an application/system. Attribute is mandatory to allow for distinguishing different applications/systems. PVD.020-01 (extension) PVD.020-02 (root) Dispensing Pharmacy number Pharmacy Identifier Facility.facilityKey DispensedItem.facilityKey | 1 | Mand | | assignedDevice : Device | 1 | Mand |
| | COCT_MT090302CA.Device |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : Business name: B:Application Name The name assigned to the application/system. Used for human communication. The name of the application must be known and is therefore marked as 'mandatory'. PVD.070 Dispensing Pharmacy Name Facility.name | 1 | Mand |
|
|
|
|
|---|
COCT_MT090310CA.AssignedDevice Business name: EHR Repository Identification of the EHR infostructure responsible for the storage and management of the record Provides context about the record and its management. |
|---|
| classCode : "ASSIGNED" (RoleClass) | 1 | Mand | | assignedRepositoryLocation : RepositoryLocation | 1 | Mand | | representedRepositoryJurisdiction : RepositoryJurisdiction | 1 | Mand |
| |
|
|
|
|
|---|
COCT_MT120600CA.Annotation Business name: Notes This is a list of comments made about the record by providers. Information captured here includes the provider making the comments; and excludes information that would render the record invalid. This information will only be seen when another provider reviews the record. Urgent or targeted messages should be sent using a different mechanism (e.g. phone). Allows various Providers to attach comments to an existing record, and thus improving cross-provider communications. Public Health requires all clinical notes to be 'verified' by a responsible party if not created by physician in charge. This model conveys the correct semantics, but is inconsistent with other uses of "author" participation in POIZ models. Any changes here will have to be reconciled with other projects using this same cmet. |
|---|
| classCode : "ACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | text : Business name: Note Text Free text comments. Additional textual iinformation entered about an object. Allows a provider to attach comments to objects for communication. This attribute is mandatory because there's no point in having a note class unless there's actually content in the note. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | languageCode : (HumanLanguage) Business name: Written in A coded value denoting the language in which the note is written. Allows providers to write notes in the language of their choice. This attribute is marked as 'populated' because the language of the note must always be known/available or a null flavor must be specified. | 1 | Pop | | author : Author | 1 | Mand |
| COCT_MT120600CA.Author Business name: *annotated by Identifies the provider responsible for the content of the note. Allows tracking of who made what comment. This attribute is marked as 'mandatory' because the provider posting a comment must always be known. Possible RIM issue: the use of author participation in this model is inconsistent with author participations used in other models, e.g author participation in Immunization event model (POIZ_MT030050CA). |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Note Timestamp The date and time at which the note was posted. Identifies timing of the annotation for sorting and for audit purposes. This attribute is mandatory because the time of creation of the annotation will always be known. | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Mand |
|
|
|
|
|---|
COCT_MT130001CA.Author3 Business name: *changed by Identity of the health service provider responsible for the change. In an EHR integrated health services environment, it is important that other providers are able to query who is responsible for a given change. Also used by applications for auditing and sorting. The attribute is mandatory because the responsible provider should always be known. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: Change Datetime The date on which the change was made. Note that this may be earlier or occassionally later than when the change is actually effective. Gives other providers the frame of reference in evaluating any post-change issues with the event. Also used for sorting and audit purposes. Time of change is always known and thus the attribute is mandatory. | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Mand |
| COCT_MT130001CA.ControlActEvent Business name: Version Information This records the history of changes that have been made to the record, including why the changes were made, who made them and when. Provides a record changes, providing deeper clinical understanding, particularly of past clinical decisions. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Change Identifier A unique identifier for this particular change. Allows referencing (and potentially undoing) a specific change. Every status change has an identifier, thus this attribute is mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Change Type Identifies what kind of change occurred. This attribute is mandatory to ensure that change types are distinguishable. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: C:Change Effective Date and End Date The date on which the various changes of an event become valid and applicable and potentially when the change is supposed to cease. Allows applications to sort and filter by time. The date on which a change is effective should always be known and thus is mandatory. The end date may be left unspecified if there isn't a specific targetted end date (e.g. with a suspend including a planned release date). | 1 | Mand | reasonCode : (ControlActReason) Business name: D:Change Reason Denotes the reason the record was modified. Ensures consistent terminology in capturing and interpreting reasons for change. Allows CWE because not all reasons will correspond to a pre-defined code. | 0-1 | Req | | author : Author3 | 1 | Mand |
|
|
|
|
|---|
COCT_MT141007CA.ClinicalDevice Business name: Device A catalog of devices (manufactured material) from which devices may be selected for prescribing/dispensing. Provides a list of devices available for prescribing/dispensing. A_BillablePharmacyDispense |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDeviceEntity) Business name: A:Device Code An identifier for a type of device. Used to ensure clear communication by uniquely identifying a particular device product when prescribing or dispensing. This attribute is only marked as 'populated' because some devices will not have codes associated with them. | 1 | Pop | name : Business name: B:Device Name The name assigned to a type of device. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. | 1 | Mand | desc : Business name: C:Device Description A free form textual description of a device and its characteristics (e.g. size, shape, etc.). This is used when additional information must be conveyed that is not apparent by just specifying code and name. Allows description of characteristics of the device not necessarily conveyed by the code or name. | 0-1 | Req | | asContent : Content | 0-1 | Req |
| COCT_MT141007CA.Content Business name: packaged in Information about how the device is packaged. May influence prescribing quantities. |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : INT.POS Business name: F:Device Package Quantity The quantity of devices contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. Attribute is marked as "mandatory" to ensure that quantity in a package is always known. | 1 | Mand | | containerPackagedDevice : PackagedDevice | 1 | Mand |
|
COCT_MT141007CA.ManufacturedProduct Business name: Device Product A medical device product intended to be supplied and/or used by a patient. Encompasses supplies, aids, etc. Allows devices to be clearly described and referenced. Also allows searching for and examining information about devices that can be or are being used by a patient. A_BillablePharmacyDispense |
|---|
| classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturedClinicalDevice : ClinicalDevice | 1 | Mand |
| |
|
|
|
|---|
COCT_MT220100CA.Content Business name: dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package quantity and Drug Container Type |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG Business name: F:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220100CA.Ingredient Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
| classCode : "INGR" (RoleClass) | 1 | Mand | negationInd :  Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is 'mandatory' because the distinction between "does/must contain" and "does/must not contain" is essential. | 1 | Mand | quantity : PQ.DRUG Business name: C:Drug Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Mand |
|
COCT_MT220100CA.Medication Business name: Drug Product A pharmaceutical product intended to be supplied and/or administered to a patient. Encompasses manufactured drug products, generic classifications, prescription medications, over-the-counter medications and recreational drugs. Allows drugs to be clearly described and referenced. Also allows searching for and examining information about medications that can be or are being used by a patient. A_BillablePharmacyDispense |
|---|
| classCode : "MED" (RoleClass) | 1 | Mand | | player : Medicine | 1 | Mand |
| COCT_MT220100CA.Medicine Business name: Drug or Compound A catalog of drugs (manufactured material) from which drugs may be selected for prescribing/dispensing. This includes: TC - Therapeutic Class; GD - Generic Drug; GF - Generic Formulation; MD - Manufactured Drug; and CMP - Compound Provides a list of drugs available for prescribing/dispensing. A_BillablePharmacyDispense |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDrug) Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccines), generic formulation, generic, therapeutic class, etc. Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name : Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc : Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | | formCode : (OrderableDrugForm) | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220100CA.Substance Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType) Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as class of ingredients in a vaccine. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name : Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
COCT_MT220110CA.Content Business name: dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package quantity and Drug Container Type; |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG Business name: F:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220110CA.Ingredient Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
| classCode : "INGR" (RoleClass) | 1 | Mand | negationInd : Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is 'populated' because the distinction between "does/must contain" and "does/must not contain" is essential, however in some circumstances it is necessary to say "may contain". | 1 | Pop | quantity : PQ.DRUG Business name: C:Drug Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Mand |
|
COCT_MT220110CA.ManufacturedProduct Business name: manufactured by Associates a drug product with the organization responsible for producing it. May be important for tracing adverse events and for performing drug searches. |
|---|
| classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturer : Manufacturer | 1 | Mand |
| COCT_MT220110CA.Manufacturer Business name: Manufacturer Identity of the organization that manufactured the drug product. Useful in distinguishing and grouping drug products |
|---|
| classCode : "ORG" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: Manufacturer Id An identifier denoting a specific drug manufacturer. Allows sending of identifiers in place of manufacturer name. May be used in drug search where specific manufacturer is a criterion. | 0-1 | Req | name : Business name: Manufacturer Name The name of the drug manufacturer. Used for reporting. The attribute is marked as "mandatory" because there will always be a name for an organization. | 1 | Mand |
|
COCT_MT220110CA.Medication Business name: Drug Product A pharmaceutical product intended to be supplied and/or administered to a patient. Encompasses manufactured drug products, generic classifications, prescription medications, over-the-counter medications and recreational drugs. Allows drugs to be clearly described and referenced. Also allows searching for and examining information about medications that can be or are being used by a patient. A_BillablePharmacyDispense |
|---|
| classCode : "MED" (RoleClass) | 1 | Mand | | player : Medicine | 1 | Mand |
| COCT_MT220110CA.Medicine Business name: Drug or Compound A catalog of drugs (manufactured material) from which drugs may be selected for prescribing/dispensing. This includes: TC - Therapeutic Class; GD - Generic Drug; GF - Generic Formulation; MD - Manufactured Drug; and CMP - Compound Provides a list of drugs available for prescribing/dispensing. A_BillablePharmacyDispense |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDrug) Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccines), generic formulation, generic, therapeutic class, etc. Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name : Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc : Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | | formCode : (OrderableDrugForm) | 0-1 | Req | | asManufacturedProduct : ManufacturedProduct | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220110CA.Substance Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType) Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as class of ingredients in a vaccine. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name : Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
COCT_MT220200CA.Content Business name: drug dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package quantity and Drug Container Type. |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG Business name: B:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220200CA.Ingredient Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
| classCode : "INGR" (RoleClass) | 1 | Mand | negationInd : Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is 'mandatory' because the distinction between "does/must contain" and "does/must not contain" is essential. | 1 | Mand | quantity : PQ.DRUG Business name: C:Drug Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Pop |
|
COCT_MT220200CA.Medication Business name: Drug Product A pharmaceutical product to be supplied and/or administered to a patient. Encompasses manufactured drug products, generic classifications, prescription medications, over-the-counter medications and recreational drugs. Allows drugs to be clearly described and referenced. Also allows searching for and examining information about medications that can be or are being used by a patient. A_BillablePharmacyDispense |
|---|
| classCode : "MED" (RoleClass) | 1 | Mand | | player : Medicine | 1 | Mand |
| COCT_MT220200CA.Medicine Business name: Drug or Compound A catalog of drugs (manufactured material) from which drugs may be selected for prescribing/dispensing. This includes pre-manufactured drug products and previously prepared compounds. Provides a list of drugs available for dispensing. A_BillablePharmacyDispense |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ManufacturedDrug) Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccine). Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers. Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name : Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc : Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | | formCode : (OrderableDrugForm) | 0-1 | Req | lotNumberText : Business name: E:Drug Lot Number Identification of a batch in which a specific manufactured drug belongs. Useful in tracking for recalls but may not always exist. X0301 RXA.15 C.6 | 0-1 | Req | expirationTime : IVL.HIGH<TS.FULLDATE> Business name: F:Drug Expiry Date Indicates either the length of time a drug product can remain viable (when talking about a drug in general terms), or the date on which the drug product is no longer considered viable (when talking about a specific medication that has been dispensed). To indicate the length of time after opening a product remains viable, specify the 'Width' property. To indicate a specific end date for an actual dispensed product, specify the 'High' property The potency, effectiveness and safety of drug products changes over time. When determining quantities to be supplied to a patient, one of the considerations is how long the drug will remain viable. DispensedItem.expiryDate Drug Expiry Date C7 | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220200CA.Substance Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType) Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as specific class of ingredients in vaccines. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name : Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
COCT_MT220210CA.Content Business name: drug dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package quantity and Drug Container Type. |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG Business name: B:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220210CA.Ingredient Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
| classCode : "INGR" (RoleClass) | 1 | Mand | negationInd : Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is 'populated' because the distinction between "does/must contain" and "does/must not contain" is essential, however in some circumstances it is necessary to say "may contain". | 1 | Pop | quantity : PQ.DRUG Business name: C:Drug Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Pop |
|
COCT_MT220210CA.ManufacturedProduct Business name: manufactured by Associates a drug product with the organization responsible for producing it. May be important for tracing adverse events and for performing drug searches. |
|---|
| classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturer : Manufacturer | 1 | Mand |
| COCT_MT220210CA.Manufacturer Business name: Manufacturer Identity of the organization that manufactured the drug product. Useful in distinguishing and grouping drug products |
|---|
| classCode : "ORG" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: Manufacturer Id An identifier denoting a specific drug manufacturer. Allows sending of identifiers in place of manufacturer name. May be used in drug search where specific manufacturer is a criterion. | 0-1 | Req | name : Business name: Manufacturer Name The name of the drug manufacturer. Used in reporting. The attribute is marked as "mandatory" because there will always be a name for an organization. | 1 | Mand |
|
COCT_MT220210CA.Medication Business name: Drug Product A pharmaceutical product to be supplied and/or administered to a patient. Encompasses manufactured drug products, generic classifications, prescription medications, over-the-counter medications and recreational drugs. Allows drugs to be clearly described and referenced. Also allows searching for and examining information about medications that can be or are being used by a patient. A_BillablePharmacyDispense |
|---|
| classCode : "MED" (RoleClass) | 1 | Mand | | player : Medicine | 1 | Mand |
| COCT_MT220210CA.Medicine Business name: Drug or Compound |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ManufacturedDrug) Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccine). Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers. Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name : Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc : Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | | formCode : (OrderableDrugForm) | 0-1 | Req | lotNumberText : Business name: E:Drug Lot Number Identification of a batch in which a specific manufactured drug belongs. Useful in tracking for recalls but may not always exist. X0301 RXA.15 C.6 | 0-1 | Req | expirationTime : IVL.HIGH<TS.FULLDATE> Business name: F:Drug Expiry Date Indicates either the length of time a drug product can remain viable (when talking about a drug in general terms), or the date on which the drug product is no longer considered viable (when talking about a specific medication that has been dispensed). To indicate the length of time after opening a product remains viable, specify the 'Width' property. To indicate a specific end date for an actual dispensed product, specify the 'High' property The potency, effectiveness and safety of drug products changes over time. When determining quantities to be supplied to a patient, one of the considerations is how long the drug will remain viable. DispensedItem.expiryDate Drug Expiry Date C7 | 0-1 | Req | | asManufacturedProduct : ManufacturedProduct | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220210CA.Substance Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType) Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as specific class of ingredients in vaccines. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name : Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
| COCT_MT240003CA.Place |
|---|
| classCode : "PLC" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : Business name: B:Service Location Name The name assigned to the service location. Used for human communication, and for cross-checking of location Id and is therefore mandatory PVD.070 Dispensing Pharmacy Name Facility.name | 1 | Mand |
| COCT_MT240003CA.ServiceDeliveryLocation Business name: Service Location An identification of a service location (or facility) where health service has been or can be delivered. E.g. Pharmacy, Medical Clinic, Hospital Used for tracking service delivery responsibility, to provide contact information for follow-up and for statistical analysis. Also important for indicating where paper records can be located. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II Business name: C:Service Location Id Unique identifier for a healthcare service location. Allows for lookup and retrieval of detailed information about a specific service location. Also ensures unique identification of service location and is therefore mandatory. The identifier is mandatory because it is the principal mechanism for uniquely identifying the facility. PVD.020-01 (extension) PVD.020-02 (root) Dispensing Pharmacy number Pharmacy Identifier Facility.facilityKey DispensedItem.facilityKey | 1 | Mand | addr : AD.BASIC Business name: D:Service Location Address The information by which a service location may be contacted either physically or by mail. Identifies the physical location of a service location and also allows for the location to be contacted. The address is marked as 'populated' because it is considered a critical piece of information about the facility, but may not always be available or meaningful. | 1 | Pop | telecom : SET<TEL.PHONEMAIL> Business name: E:Service Location Phones and E-mails The phone numbers and/or electronic mail addresses by which a service location may be contacted. Allows a service location to be communicated with and is therefore important. Because a contact number won't always exist, the field is marked 'populated'. | 1-5 | Pop | | location : Place | 1 | Mand |
|
|
|
|
|---|
| COCT_MT470000CA.Author Business name: b:consented to by Indicates that the consent was provided by the patient or representative. Consent can be provided by the patient or representative or the provider. Authorization.Person Authorization.signatory(PT) |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | modeCode : (x_PhysicalVerbalParticipationMode) Business name: Patient Consent Mechanism Indicates whether the patient's consent is written or verbal. Verbal consents may trigger a higher level of auditing. | 0-1 | Req | signatureText : ED.SIGNATURE Business name: Keyword Indicates the keyword appropriate to the action being performed by the message. Allows providers who know the keyword to access information protected by patient keywords. | 0-1 | Req | | Choice: consenter : Consenter | 1 | Pop | | »» patient : Patient | 0-1 | Opt | | »» responsibleParty : ResponsibleParty | 0-1 | Opt |
|
COCT_MT470000CA.Author2 Business name: c:consent overridden by Indicates that information access was approved by a provider rather than a patient. I.e. This is an override rather than an actual consent, and is used for the purposes of 'breaking the glass' only. Clinical circumstances may demand that a patient's information be accessed without consent to ensure patient safety. Authorization.signatory(PROV) |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| COCT_MT470000CA.ConsentEvent Business name: Consent Information pertaining to a patient's agreement/acceptance to have his/her clinical information electronically stored and shared. The keywords will not be passed from prescriber to dispenser by the DIS. Provides authorization to record and/or view patient information. Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis. May be required on a Prescription Request to indicate a keyword for DUR processing. One and only one of author2 (Consenter) and author1 (Provider) must be specified. If author1 (provider) is specified, reason code must be specified. |
|---|
| classCode : "CONS" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: D:Consent Form Number A unique identifier for a specific consent for a patient. Provides a traceable audit link between a physical consent form and its electronic record Authorization.formNumber | 0-1 | Req | | code : "INF" (ActCode) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: C:Consent Effective and End Time Indicates the time that the consent will expire. 'Low' is effective time and 'High' is end time. Most consents are not open-ended, to ensure the patient retains a level of control. Authorization.endTime (high) | 0-1 | Req | reasonCode : (ActConsentInformationAccessReason) Business name: E:Consent Override Reason Indicates a reason for overriding a patient's consent rules. Important for audit purposes Authorization.reason (mnemonic) Authorization.comment (original text) | 0-1 | Req | | subject1 : Subject | 1 | Mand | | author1 : Author2 | 0-1 | Req | | author2 : Author | 0-1 | Req | | subject2 : Subject2 | 1 | Mand |
|
| |
COCT_MT470000CA.Patient Business name: Consent By Patient Indicates that the consent or keyword has been provided by the patient themselves (rather than a representative.) Distinguishing whether consent is granted by the patient or a representative can be important for audit purposes. |
|---|
| classCode : "PAT" (RoleClass) | 1 | Mand |
| COCT_MT470000CA.Receiver Business name: *consent given to Identifies the beneficiary of the consent as being a Provider or Service Location. Indicates who is receiving consent to view information. This participation is marked as "populated" as receiver must be specified when keyword is involved. |
|---|
| typeCode : "RCV" (ParticipationType) | 1 | Mand | | Choice: recipient : Recipient | 1 | Pop | | »» assignedPerson : AssignedPerson | 0-1 | Opt | | »» serviceDeliveryLocation : ServiceDeliveryLocation | 0-1 | Opt |
|
| COCT_MT470000CA.Subject Business name: *a:consent pertains to The patient's record the consent is associated with. Essential for knowing what patient the consent is for, and therefore mandatory. |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | patient : Patient | 1 | Mand |
|
| |
|
|
|
|---|
COMT_MT300001CA.Annotation Business name: Comment Identifies the comments to be recorded against a Patient's record. Allows comments to be attached to a Patient record. A Patient record can pertain to demographic or clinical (Drug, Condition, Lab, DI, Immunization, etc) information. |
|---|
| classCode : "ACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPatientAnnotationCode) Business name: Patient Note Category A coded value denoting the category of note being attached to a Patient's record. Categories of note include: General, Medication, Lab, DI, Immunization, etc Allows patient notes of different purposes and use, to be attached to a patient. Attribute is mandatory to ensure that patient notes are categorized accordingly. This attribute may also be used by DISs to enforce different access control to different types of notes. | 1 | Mand | text : Business name: C:Patient Note Text Free textual description of the patient note. Allows a provider to attach comments to a patient as a whole or to the patient's profile (such as medication, lab. DI, etc). This attribute is mandatory because there's no point in having a patient note unless there's actually content in the note. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | | recordTarget : RecordTarget | 1 | Mand |
| COMT_MT300001CA.RecordTarget Business name: *comment pertains to Identity of the Patient to which the note pertains. This relationship is mandatory because the Patient must first be identified before any annotation is applied to the patient's record. |
|---|
| typeCode : "RCT" (ParticipationType) | 1 | Mand | | patient : Patient | 1 | Mand |
|
|
|
|
|---|
| | COMT_MT300002CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and therefore mandatory. | 1 | Mand |
|
| COMT_MT300002CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and therefore mandatory. | 1 | Mand |
| | COMT_MT300002CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient drug contraindication query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
|
| COMT_MT300002CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name of the patient who is the subject of the drug contraindication query. Filter the result set to include only those records pertaining to the patient with this name. Allows filtering of result set by patient name. This is a mandatory field because a patient name must match the patient Id for the query to be valid. | 1 | Mand |
| | COMT_MT300002CA.PatientNoteCategoryCode |
|---|
value : (ActPatientAnnotationCode) Business name: Patient Note Category Code Indicates that the result set is to be filtered to include only those patient annotation pertaining to the specified annotation category. Valid patient note categories include: General, Medication, Lab, DI, etc. Allows for the retrieval of all patient notes pertaining to a specific note category. | 1 | Mand |
|
|
|
|
|---|
COMT_MT300003CA.Annotation Business name: Comment Identifies the comments to be recorded against a Patient's record. Allows comments to be attached to a Patient record. A Patient record can pertain to demographic or clinical (Drug, Condition, Lab, DI, etc) information. |
|---|
| classCode : "ACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Patient Note Id Identifier of the patient note record. Allows for the unique reference of a patient note and is therefore mandatory. Allows for referencing of a particular patient note and thus allows for the removal of the note. | 1 | Mand | code : (ActPatientAnnotationCode) Business name: A:Patient Note Category A coded value denoting the category of note being attached to a Patient's record. Categories of note include: General, Medication, Lab, DI, etc. Allows patient notes of different purposes and use, to be attached to a patient. Attribute is mandatory to ensure that patient notes are categorized accordingly. This attribute may also be used by DISs to enforce different access control to different types of notes. | 1 | Mand | text : Business name: C:Patient Note Text Free textual description of the patient note. Allows a provider to attach comments to a patient as a whole or to the patient's profile (such as medication, lab. DI, etc). This attribute is mandatory because there's no point in having a patient note unless there's actually content in the note. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author | 1 | Mand | | location : Location | 1 | Mand |
| COMT_MT300003CA.Author Business name: *b:annotated by Identifier of the provider who created the patient note. Allows other providers to communicator with the author of the note for follow-up enquiries. The author of an annotation must always be known and is therefore mandatory. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: B:Patient Note Date The date on which the patient note was created. Allows other provider to evaluate the currency of the information contained in the note. The date of the note creation is always known and is therefore mandatory. | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Mand |
|
COMT_MT300003CA.Location Business name: *c:recorded at Indicates the facility/location where the patient note was recorded. Important for performing follow-up and is therefore mandatory. |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Mand |
| COMT_MT300003CA.RecordTarget Business name: *a:comment pertains to Identity of the Patient to which the note pertains. This relationship is mandatory because the Patient must first be identified before any annotation is applied to the patient's record. |
|---|
| typeCode : "RCT" (ParticipationType) | 1 | Mand | | patient : Patient | 1 | Mand |
|
COMT_MT300003CA.ResponsibleParty Business name: supervised by Identification of the provider who was supervising the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
|
|
|
|
|---|
| |
COMT_MT301001CA.Subject Business name: annotates Indicates the particular record to which the annotation applies. Ensures the annotation is connected to the correct record, and therefore mandatory. |
|---|
| typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | | annotatedAct : AnnotatedAct | 1 | Mand |
| COMT_MT301001CA.Subject2 Business name: *comment pertains to Identity of the Patient to which the comment pertains. This relationship is mandatory because the Patient must first be identified before any annotation is applied to the patient's record. |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | patient : Patient | 1 | Mand |
|
|
|
|
|---|
COMT_MT400001CA.Diagnosis Business name: Diagnosis Conveys information about a diagnosis to be masked Allows masking of items related to a particular medical condition. If code is SNOMED, value must not be specified. Otherwise value is mandatory and code must be DX |
|---|
| classCode : "OBS" (ActClass) | 1 | Mand | | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | code : (ActCode) Business name: A:Diagnosis Type Used to indicate that this observation is a diagnosis, and for SNOMED, provides details of what the diagnosis is. Needed to convey the diagnosis information to be masked, and attribute is therefore mandatory. | 1 | Mand | value : (DiagnosisValue) Business name: B:Diagnosis The diagnosis whose associated records should be masked. Allows masking of all records (prescriptions, dispenses, encounters, lab tests, etc.) associated with the specified diagnosis. This element is optional because it is not used for SNOMED. | 0-1 | Opt |
| |
| COMT_MT400001CA.MaskableActType Business name: Maskable Record A particular record or type of record for which masking is supported. The root construct for masking and unmasking specific record or type of record. |
|---|
| classCode : "ACT" (ActClass) | 1 | Mand | | moodCode : "EVNINT.CRT" (ActMood) | 1 | Mand | id : II Business name: C:Record Identifier The identifier of the prescription, dispense, allergy, lab test result or other record for which the masking status is being changed. In many systems, masking a 'child' may result in automatic masking of the parent. For example, masking a dispense record may cause the prescription to become masked as well. Allows unique reference to a particular record to be masked or unmasked. | 0-1 | Req | code : (ActInformationCategoryCode) Business name: B:Record Type Indicates a detailed type of record to be masked. E.g. All lab tests of a given type. Allows automatic masking of a particular type of record rather than requiring each occurrence to be masked individually. | 0-1 | Req | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: A:Masked Indicator Indicates the new value for the masking status of the item. Forces the sender of the message to assert what the new value should be, rather than performing a 'toggle' and potentially ending up in the wrong state. Therefore, the attribute is mandatory. | 1 | Mand | | directTarget : DirectTarget | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | reason : Reason | 0-1 | Req |
|
| |
|
|
|
|
|---|
|
|
|
|
|---|
MCAI_MT700210CA.Author Business name: a:*created by Indicates the person responsible for the event that caused this message. Critical for auditing and for validating permissions and therefore mandatory. |
|---|
typeCode : "AUT" (ParticipationType) Value should always be AUT | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: D:Time of Creation The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.) This date can be back-dated. The time a change is made is a critical piece of audit information and is therefore mandatory. | 1 | Mand | modeCode : (ParticipationMode) Business name: F:Information Received Method Indicates how the person who recorded the event became aware of it.. E.g. Verbal, written, fax, etc. May have ramifications for the audit trail and reliability of the information. | 0-1 | Req | signatureText : ED.SIGNATURE Business name: G:Digital Signature Indicates the formal digital signature of the message content. Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. | 0-1 | Opt | | assignedPerson : AssignedPerson | 1 | Mand |
| MCAI_MT700210CA.ControlActEvent Business name: Trigger Event Identifies the action that resulted in this message being sent. There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Key to understanding what action a message represents. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. The attribute is therefore mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Event Type Identifies the trigger event that occurred. This is mandatory because it is essential to understanding the meaning of the event. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: C:Event Effective Period Indicates the time the change should begin (and occasionally when it should end). If not specified, assumption is that the event occurred at the same time the message was constructed. The time a change becomes effective may differ from the time the event is recorded. (I.e. it may be in the future or the past). For changes such as 'suspend', an intended end date may also be indicated. | 0-1 | Req | reasonCode : (ControlActReason) Business name: E:Event Reason Identifies why this specific query, modification request, or modification occurred. Allows identifying a reason for a specific action, such as 'reason for hold'. Also allows identifying reason for accessing information for a query. | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Req | | dataEntryLocation : DataEntryLocation | 0-1 | Req | | location : Location | 1 | Mand | | subject : Subject2 | 1 | Mand | | subjectOf1 : Subject | 0-50 | Req | | subjectOf2 : Subject3 | 0-1 | Req |
|
MCAI_MT700210CA.DataEnterer Business name: b:*entered by Indicates the person responsible for recording the information into the system. Used for audit purposes. Used when different from the person responsible for making the decision. This should only be specified if different from the author. Important for audit information and determining permissions. |
|---|
| typeCode : "ENT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| |
| |
| MCAI_MT700210CA.Subject2 Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. If there are multiple subject items, the changes to all of them must be either accepted or rejected as a single action. I.e. One trigger event = 1 unit of work. Provides information about the thing being created or modified. |
|---|
| typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : Business name: Cascade Responsibility Indicator Indicates whether or not objects of the trigger event are to be cascaded to the payload. Cascading of trigger event objects allows different messages to employ consistent and common objects. Attribute is mandatory to ensure that cascading will be specified one way or another. On creation interactions (where the state transition is null->active), this must be true otherwise it must be false. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|
|---|
MCAI_MT700211CA.ControlActEvent Business name: Trigger Event Identifies the action that resulted in this message being sent. There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Key to understanding what action a message represents. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. These identifiers should be stored for use in 'retractions'. They should be stored in such a way that they are associated with the item that was modified by this event. For example, a system should be able to show the list of trigger event identifiers for the actions that have been recorded against a particular prescription. Allows the event to be referenced (for retractions) and also indicates whether multiple interactions were caused by the same triggering event. The attribute is therefore mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Event Type Identifies the trigger event that occurred. This is mandatory because it is essential to understanding the meaning of the event. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: C:Event Effective Period Indicates the time the change should begin (and occasionally when it should end). If not specified, assumption is that the event occurred at the same time the message was constructed. Example use is to record a dispense pickup time on the Rx Pickup Notification interaction. This time may be in the past, but cannot be in the future. The time a change becomes effective may differ from the time the event is recorded. (I.e. it may be in the future or the past). For changes such as 'suspend', an intended end date may also be indicated. | 0-1 | Req | reasonCode : (ControlActReason) Business name: E:Event Reason Identifies why this specific query, modification request, or modification occurred. The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Allows identifying a reason for a specific action, such as 'reason for hold'. Also allows identifying reason for accessing information for a query. | 0-1 | Req | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
|
|
|
|
|---|
MCAI_MT700220CA.ControlActEvent Business name: Trigger Event Identifies the action that resulted in this message being sent. There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Key to understanding what action a message represents. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. These identifiers should be stored for use in 'retractions'. They should be stored in such a way that they are associated with the item that was modified by this event. For example, a system should be able to show the list of trigger event identifiers for the actions that have been recorded against a particular prescription. Allows the event to be referenced (for retractions) and also indicates whether multiple interactions were caused by the same triggering event. The attribute is therefore mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Event Type Identifies the trigger event that occurred. This is mandatory because it is essential to understanding the meaning of the event. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: C:Event Effective Period Indicates the time the change occurred. If not populated, the assumption is the same time the message was constructed. The time a change becomes effective may differ from the time the event is recorded. (I.e. it may be in the future or the past). For changes such as 'suspend', an intended end date may also be indicated. | 0-1 | Req | reasonCode : (ControlActReason) Business name: E:Event Reason Identifies why this specific query, modification request, or modification occurred. The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Allows identifying a reason for a specific action, such as 'reason for hold'. Also allows identifying reason for accessing information for a query. | 0-1 | Req | | subject : Subject2 | 0-1 | Req | | subjectOf : Subject | 0-50 | Req |
| |
|
|
|
|
|---|
MCAI_MT700221CA.Author Business name: a:*created by Indicates the person responsible for the event that caused this message. Critical for auditing and for validating permissions and therefore mandatory. |
|---|
typeCode : "AUT" (ParticipationType) Value should always be AUT | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: D:Time of Creation The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.) This date can be back-dated. The time a change is made is a critical piece of audit information and is therefore mandatory. | 1 | Mand | modeCode : (ParticipationMode) Business name: F:Information Received Method Indicates how the person who recorded the event became aware of it. E.g. Verbal, written, fax, etc. May have ramifications for the audit trail and reliability of the information. | 0-1 | Req | signatureText : ED.SIGNATURE Business name: G:Digital Signature Indicates the formal digital signature of the message content. Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. | 0-1 | Opt | | assignedPerson : AssignedPerson | 1 | Mand |
| MCAI_MT700221CA.ControlActEvent Business name: Trigger Event Identifies the action that resulted in this message being sent. There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Key to understanding what action a message represents. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. These identifiers should be stored for use in 'retractions'. They should be stored in such a way that they are associated with the item that was modified by this event. For example, a system should be able to show the list of trigger event identifiers for the actions that have been recorded against a particular prescription. Allows the event to be referenced (for retractions) and also indicates whether multiple interactions were caused by the same triggering event. The attribute is therefore mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Event Type Identifies the trigger event that occurred. This is mandatory because it is essential to understanding the meaning of the event. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: C:Event Effective Period Indicates the time the occurred. If not specified, assumption is that the event occurred at the same time the message was constructed. The time a change becomes effective may differ from the time the event is recorded. (I.e. it may be in the future or the past). For changes such as 'suspend', an intended end date may also be indicated. | 0-1 | Req | reasonCode : (ControlActReason) Business name: E:Event Reason Identifies why this specific query, modification request, or modification occurred. The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Allows identifying a reason for a specific action, such as 'reason for hold'. Also allows identifying reason for accessing information for a query. | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Req | | dataEntryLocation : DataEntryLocation | 0-1 | Req | | location : Location | 1 | Mand | | subject : Subject2 | 0-1 | Req | | subjectOf : Subject | 0-50 | Req |
|
MCAI_MT700221CA.DataEnterer Business name: b:*entered by Indicates the person responsible for recording the information into the system. Used for audit purposes. Used when different from the person responsible for making the decision. This should only be specified if different from the author. Important for audit information and determining permissions. |
|---|
| typeCode : "ENT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| |
| |
| |
|
|
|
|---|
MCAI_MT700222CA.ControlActEvent Business name: Trigger Event Identifies the action that resulted in this message being sent. There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Key to understanding what action a message represents. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. These identifiers should be stored for use in 'retractions'. They should be stored in such a way that they are associated with the item that was modified by this event. For example, a system should be able to show the list of trigger event identifiers for the actions that have been recorded against a particular prescription. Allows the event to be referenced (for retractions) and also indicates whether multiple interactions were caused by the same triggering event. The attribute is therefore mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Event Type Identifies the trigger event that occurred. This is mandatory because it is essential to understanding the meaning of the event. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: C:Event Effective Period Indicates the time the change occurred. If not populated, the assumption is the same time the message was constructed. The time a change becomes effective may differ from the time the event is recorded. (I.e. it may be in the future or the past). For changes such as 'suspend', an intended end date may also be indicated. | 0-1 | Req | reasonCode : (ControlActReason) Business name: E:Event Reason Identifies why this specific query, modification request, or modification occurred. The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Allows identifying a reason for a specific action, such as 'reason for hold'. Also allows identifying reason for accessing information for a query. | 0-1 | Req | | subjectOf : Subject | 0-50 | Req |
| |
|
|
|
|---|
MCAI_MT700223CA.Author Business name: a:*created by Indicates the person responsible for the event that caused this message. Critical for auditing and for validating permissions and therefore mandatory. |
|---|
typeCode : "AUT" (ParticipationType) Value should always be AUT | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: D:Time of Creation The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.) This date can be back-dated. The time a change is made is a critical piece of audit information and is therefore mandatory. | 1 | Mand | modeCode : (ParticipationMode) Business name: F:Information Received Method Indicates how the person who recorded the event became aware of it. E.g. Verbal, written, fax, etc. May have ramifications for the audit trail and reliability of the information. | 0-1 | Req | signatureText : ED.SIGNATURE Business name: G:Digital Signature Indicates the formal digital signature of the message content. Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. | 0-1 | Opt | | assignedPerson : AssignedPerson | 1 | Mand |
| MCAI_MT700223CA.ControlActEvent Business name: Trigger Event Identifies the action that resulted in this message being sent. There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Key to understanding what action a message represents. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. These identifiers should be stored for use in 'retractions'. They should be stored in such a way that they are associated with the item that was modified by this event. For example, a system should be able to show the list of trigger event identifiers for the actions that have been recorded against a particular prescription. Allows the event to be referenced (for retractions) and also indicates whether multiple interactions were caused by the same triggering event. The attribute is therefore mandatory. | 1 | Mand | code : (HL7TriggerEventCode) Business name: A:Event Type Identifies the trigger event that occurred. This is mandatory because it is essential to understanding the meaning of the event. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: C:Event Effective Period Indicates the time the occurred. If not specified, assumption is that the event occurred at the same time the message was constructed. The time a change becomes effective may differ from the time the event is recorded. (I.e. it may be in the future or the past). For changes such as 'suspend', an intended end date may also be indicated. | 0-1 | Req | reasonCode : (ControlActReason) Business name: E:Event Reason Identifies why this specific query, modification request, or modification occurred. The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Allows identifying a reason for a specific action, such as 'reason for hold'. Also allows identifying reason for accessing information for a query. | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Req | | dataEntryLocation : DataEntryLocation | 0-1 | Req | | location : Location | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
|
MCAI_MT700223CA.DataEnterer Business name: b:*entered by Indicates the person responsible for recording the information into the system. Used for audit purposes. Used when different from the person responsible for making the decision. This should only be specified if different from the author. Important for audit information and determining permissions. |
|---|
| typeCode : "ENT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| |
| |
|
|
|
|
|---|
| |
| MCCI_MT000100CA.AttentionLine Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText : Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value : Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
|
| MCCI_MT000100CA.Device1 |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: IA:Sending Application Identifier The unique identifier of the application or system from where the message is being sent. Because this is the key identifier of where the message is coming from, this attribute is mandatory. | 1 | Mand | name : Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc : Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE> Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName : Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName : Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
| |
MCCI_MT000100CA.Device3 Business name: Respond To System The system to which responses are to be directed. Provides support for directing responses to applications other than the original sender. |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: KA:Respond to Application Identifier The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. | 1 | Mand | | asAgent : Agent3 | 0-1 | Opt | | asLocatedEntity : LocatedEntity3 | 0-1 | Opt |
| |
| |
MCCI_MT000100CA.Message Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText : Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | versionCode : (HL7StandardVersionCode) Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : SET<II> Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID) Business name: D:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition) Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | respondTo : RespondTo | 0-1 | Opt | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt | | controlActProcess : | 1 | Mand |
| |
| |
| |
| | MCCI_MT000100CA.Receiver |
|---|
| typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device2 | 1 | Mand |
|
MCCI_MT000100CA.RespondTo Business name: to be responded to by Indicates the interaction that should receive the response to this interaction. Used when different from the sender of the original interaction. In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
|---|
| typeCode : "RSP" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: KB:Respond to Network Address Indicates the address to send acknowledgments of this message to. Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device3 | 1 | Mand |
| | MCCI_MT000100CA.Sender |
|---|
| typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device1 | 1 | Mand |
|
|
|
|
|---|
| MCCI_MT000200CA.Acknowledgement |
|---|
typeCode : (AcknowledgementType) Business name: GA:Acknowledgement Code Indicates whether the previous interaction was successfully processed. Key to understanding whether the interaction has been successful and is therefore mandatory. | 1 | Mand | messageWaitingNumber : INT.NONNEG Business name: GC:Number of Waiting Messages For applications which support polling, indicates the total number of messages waiting to be retrieved. Indicates to a system how many polled messages are available without the need so send a separate query. The element is optional because not all systems will support polling. | 0-1 | Opt | messageWaitingPriorityCode : (MessageWaitingPriority) Business name: GD:Message Waiting Priority Indicates the priority of the highest-priority message that is waiting on the poll queue for the system being responded to. The priority of the waiting message may influence how quickly the polling system may choose to download queued messages. The element is optional because not all systems will support polling. | 0-1 | Opt | | targetMessage : TargetMessage | 1 | Mand | | acknowledgementDetail : AcknowledgementDetail | 0-50 | Req |
| MCCI_MT000200CA.AcknowledgementDetail Business name: Errors or Warnings An error, warning or information message associated with the message being acknowledged. Allows identification issues related to the parsing and low-level processing of the message. |
|---|
typeCode : (AcknowledgementDetailType) Business name: Message type Distinguishes between errors, warnings and information messages. Different types of messages have substantially different ramifications. As a result, the element is mandatory. | 1 | Mand | code : (AcknowledgementDetailCode) Business name: A:Response Code Indicates the specific issue represented by this message. By providing coded identification of issues and errors, allows applications to have logic that manages particular errors and warnings automatically. However in some circumstances, a code may not be available. Therefore the attribute is marked as 'populated'. | 1 | Pop | text : Business name: C:Message Description The human-readable description of the error, warning or information message. May convey additional details not present in the 'code', but is not intended to be human-processable. Allows supplementing the 'computer' information for human-readability. | 0-1 | Req | location : SET<ST> Business name: B:Referenced Message Locations Indicates the location of the elements within the message instance that triggered this error, warning or information message. I.e. only the default 'child' axis is permitted, occurrence numbers are always specified, and no other predicates are permitted. Allows syntax and other messages to be linked to particular fields within the message. | 0-5 | Req |
|
| |
| MCCI_MT000200CA.AttentionLine Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText : Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value : Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
|
| MCCI_MT000200CA.Device1 |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: IA:Sending Application Identifier The unique identifier of the application or system to whom the message is being routed. Because this is the key identifier of where the message is intended to go, this attribute is mandatory. | 1 | Mand | name : Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc : Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE> Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName : Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName : Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
| |
MCCI_MT000200CA.Device3 Business name: Respond To System The system to which responses are to be directed. Provides support for directing responses to applications other than the original sender. |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: KA:Respond to Application Identifier The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. | 1 | Mand | | asAgent : Agent3 | 0-1 | Opt | | asLocatedEntity : LocatedEntity3 | 0-1 | Opt |
| |
| |
MCCI_MT000200CA.Message Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText : Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | versionCode : (HL7StandardVersionCode) Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : SET<II> Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID) Business name: D:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition) Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | respondTo : RespondTo | 0-1 | Opt | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt | | acknowledgement : Acknowledgement | 1 | Mand |
| |
| |
| |
| | MCCI_MT000200CA.Receiver |
|---|
| typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device2 | 1 | Mand |
|
MCCI_MT000200CA.RespondTo Business name: to be responded to by Indicates the interaction that should receive the response to this interaction. Used when different from the sender of the original interaction. In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
|---|
| typeCode : "RSP" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: KB:Respond to Network Address Indicates the address to send acknowledgments of this message to. Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device3 | 1 | Mand |
| | MCCI_MT000200CA.Sender |
|---|
| typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device1 | 1 | Mand |
|
| MCCI_MT000200CA.TargetMessage |
|---|
id : II Business name: BA:Acknowledged Message Id References the identifier of the message this current message is acknowledging. Provides the necessary link to complete a conversation for systems using communication technologies which are not conversational. This attribute is therefore mandatory. | 1 | Mand |
|
|
|
|
|---|
| MCCI_MT000300CA.Acknowledgement |
|---|
typeCode : (AcknowledgementType) Business name: GA:Acknowledgement Code Indicates whether the previous interaction was successfully processed. Key to understanding whether the interaction has been successful and is therefore mandatory. | 1 | Mand | messageWaitingNumber : INT.NONNEG Business name: GC:Number of Waiting Messages For applications which support polling, indicates the total number of messages waiting to be retrieved. Indicates to a system how many polled messages are available without the need so send a separate query. The element is optional because not all systems will support polling. | 0-1 | Opt | messageWaitingPriorityCode : (MessageWaitingPriority) Business name: GD:Message Waiting Priority Indicates the priority of the highest-priority message that is waiting on the poll queue for the system being responded to. The priority of the waiting message may influence how quickly the polling system may choose to download queued messages. The element is optional because not all systems will support polling. | 0-1 | Opt | | targetMessage : TargetMessage | 1 | Mand | | acknowledgementDetail : AcknowledgementDetail | 0-50 | Req |
| MCCI_MT000300CA.AcknowledgementDetail Business name: Errors or Warnings An error, warning or information message associated with the message being acknowledged. Allows identification issues related to the parsing and low-level processing of the message. |
|---|
typeCode : (AcknowledgementDetailType) Business name: Message type Distinguishes between errors, warnings and information messages. Different types of messages have substantially different ramifications. | 1 | Mand | code : (AcknowledgementDetailCode) Business name: A:Response Code Indicates the specific issue represented by this message. By providing coded identification of issues and errors, allows applications to have logic that manages particular errors and warnings automatically. However in some circumstances, a code may not be available. Therefore the attribute is marked as 'populated'. | 1 | Pop | text : Business name: C:Message Description The human-readable description of the error, warning or information message. May convey additional details not present in the 'code', but is not intended to be human-processable. Allows supplementing the 'computer' information for human-readability. | 0-1 | Req | location : SET<ST> Business name: B:Referenced Message Locations Indicates the location of the elements within the message instance that triggered this error, warning or information message. I.e. only the default 'child' axis is permitted, occurrence numbers are always specified, and no other predicates are permitted. Allows syntax and other messages to be linked to particular fields within the message. | 0-5 | Req |
|
| |
| MCCI_MT000300CA.AttentionLine Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText : Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value : Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
|
| MCCI_MT000300CA.Device1 |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: IA:Sending Application Identifier The unique identifier of the application or system to whom the message is being routed. Because this is the key identifier of where the message is intended to go, this attribute is mandatory. | 1 | Mand | name : Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc : Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE> Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName : Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName : Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
| |
MCCI_MT000300CA.Device3 Business name: Respond To System The system to which responses are to be directed. Provides support for directing responses to applications other than the original sender. |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: KA:Respond to Application Identifier The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. | 1 | Mand | | asAgent : Agent3 | 0-1 | Opt | | asLocatedEntity : LocatedEntity3 | 0-1 | Opt |
| |
| |
MCCI_MT000300CA.Message Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText : Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | versionCode : (HL7StandardVersionCode) Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : SET<II> Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID) Business name: D:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition) Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | respondTo : RespondTo | 0-1 | Opt | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt | | acknowledgement : Acknowledgement | 1 | Mand | | controlActProcess : | 0-1 | Req |
| |
| |
| |
| | MCCI_MT000300CA.Receiver |
|---|
| typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device2 | 1 | Mand |
|
MCCI_MT000300CA.RespondTo Business name: to be responded to by Indicates the interaction that should receive the response to this interaction. Used when different from the sender of the original interaction. In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
|---|
| typeCode : "RSP" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: KB:Respond to Network Address Indicates the address to send acknowledgments of this message to. Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device3 | 1 | Mand |
| | MCCI_MT000300CA.Sender |
|---|
| typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device1 | 1 | Mand |
|
| MCCI_MT000300CA.TargetMessage |
|---|
id : II Business name: BA:Acknowledged Message Id References the identifier of the message this current message is acknowledging. Provides the necessary link to complete a conversation for systems using communication technologies which are not conversational. This attribute is therefore mandatory. | 1 | Mand |
|
|
|
|
|---|
| |
| MCCI_MT102001CA.AttentionLine Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText : Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value : Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
|
| MCCI_MT102001CA.Device1 |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: IA:Sending Application Identifier The unique identifier of the application or system to whom the message is being routed. Because this is the key identifier of where the message is intended to go, this attribute is mandatory. | 1 | Mand | name : Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc : Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE> Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName : Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName : Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
| |
MCCI_MT102001CA.Device3 Business name: Respond To System The system to which responses are to be directed. Provides support for directing responses to applications other than the original sender. |
|---|
| classCode : "DEV" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: KA:Respond to Application Identifier The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. | 1 | Mand | | asAgent : Agent3 | 0-1 | Opt | | asLocatedEntity : LocatedEntity3 | 0-1 | Opt |
| |
| |
MCCI_MT102001CA.Message Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText : Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | versionCode : (HL7StandardVersionCode) Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : SET<II> Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID) Business name: D:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition) Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | respondTo : RespondTo | 0-1 | Opt | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt |
| |
| |
| |
| | MCCI_MT102001CA.Receiver |
|---|
| typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device2 | 1 | Mand |
|
MCCI_MT102001CA.RespondTo Business name: to be responded to by Indicates the interaction that should receive the response to this interaction. Used when different from the sender of the original interaction. In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
|---|
| typeCode : "RSP" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: KB:Respond to Network Address Indicates the address to send acknowledgments of this message to. Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device3 | 1 | Mand |
| | MCCI_MT102001CA.Sender |
|---|
| typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device1 | 1 | Mand |
|
|
|
|
|---|
| |
POIZ_MT030050CA.Consumable2 Business name: *c:administered Identifies the vaccine being recorded. The vaccine is the key part of the administration record. However because SNOMED can pre-coordinate the vaccine into code, the association is only 'required'. RXA-5 (Immunization Agent) Association is mandatory when not using SNOMED |
|---|
| typeCode : "CSM" (ParticipationType) | 1 | Mand | | contextControlCode : "ON" (ContextControl) | 1 | Mand | | medication : Medication | 1 | Pop |
| POIZ_MT030050CA.Immunization Business name: Immunization Represents a single immunization occurrence for a particular patient Allows capturing a patient's immunization profile approachSite must be required if not using SNOMED Route must be required if not using SNOMED If immunization was not refused, then refusal reason must not be specified otherwise field should be treated as populated. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (ActCode) Business name: Immunization Type Indicates what type of administration is being performed. Indicates that the type of administration is an administration, and for SNOMED, also indicates the specific type of administration. Thus the attribute is mandatory. The datatype is CD to allow for SNOMED post-coordination. | 1 | Mand | negationInd : Business name: Not Immunized? An explicit indication that a person has not been immunized with the specified vaccine at the time indicated. Tracking failures to be immunized is also important in immunization reporting. This flag must always be known and is always mandatory. NotImmunizedFlag CompletionStstus (true = Not administered) | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: C:Immunization Date The date vaccination(s) was administered to the patient. Important information for establishing the validity of the immunization records, and therefore mandatory. Also used in the scheduling of subsequent immunizations. DateOfVaccination | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: D:Immunization Masking Indicator Denotes access restriction placed on the immunization record. Methods for accessing masked immunization records will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). The default is 'NORMAL'. Provides support for additional confidentiality constraint to reflect the wishes of the patient. The attribute is optional because not all systems will support masking. | 0-1 | Opt | reasonCode : (ActNoImmunizationReason) Business name: Immunization Refusal Reason A coded value denoting a patient's reason for refusing to be immunized. Typical reasons include: Parental decision, Religious exemption, Patient decision, etc Useful information for planning future immunization encounters for the patient. CompletionStatus (Refused) | 0-1 | Req | routeCode : (RouteOfAdministration) Business name: E:Route of Administration This is the means by which the drug was administered to the patient. Ensures consistency in description of routes. Attribute is marked "optional" to allow for use of pre-coordinated SNOMED Codes. RXR-1 | 0-1 | Opt | approachSiteCode : (HumanSubstanceAdministrationSite) Business name: Administration Site A coded value denoting the body area where the immunization was administered. This is also referred to as the anatomical site of vaccination. Some immunizations are intended to adjust from site to site. (E.g. if first injection is given in right deltoid, first booster should be given in left deltoid.) Attribute is marked "optional" to allow for use of pre-coordinated SNOMED Codes. RXR.2 | 0-1 | Opt | doseQuantity : PQ.DRUG Business name: Quantity Administered The amount of the vaccine administered to/by the patient. Useful for evaluating reaction and for checking contraindication. Attribute is populated to allow for situations where quantity may not be known and thus null flavor must be specified. | 1 | Pop | | subject : Subject10 | 1 | Mand | | consumable : Consumable2 | 0-1 | Req | | informant : Informant | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf3 | 0-1 | Req | | subjectOf : Subject9 | 0-1 | Req | | cause : CauseOf | 0-1 | Req |
|
| |
| |
| |
| |
| |
|
|
|
|---|
| |
POIZ_MT030060CA.Consumable Business name: *c:administered Identifies the vaccine being recorded. The vaccine is the key part of the administration record. However because SNOMED can pre-coordinate the vaccine into code, the association is only 'required'. RXA-5 (Immunization Agent) Association is mandatory when not using SNOMED |
|---|
| typeCode : "CSM" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | medication : Medication | 1 | Pop |
| POIZ_MT030060CA.Immunization Business name: Immunizations A record of a patient's immunizations. Necessary component of a person's overall medication profile. Helps deal with outbreaks and also drug contraindication checking. approachSite must be required if not using SNOMED Route must be required if not using SNOMED |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Immunization Record Id This is an identifier assigned to a unique instance of an immunization record. Allows for the unique referencing of a specific immunization record. Thus the mandatory requirement. | 1 | Mand | code : CD (ActCode) Business name: Immunization Type Indicates what type of administration is being performed. Indicates that the type of administration is an administration, and for SNOMED, also indicates the specific type of administration. Thus the attribute is mandatory. The datatype is CD to allow for SNOMED post-coordination. | 1 | Mand | negationInd : Business name: Not Immunized? An explicit indication that a person has not been immunized with the specified vaccine at the time indicated. Tracking failures to be immunized is also important in immunization reporting. The attribute is mandatory because it is not meaningful to record an immunization where it is unknown | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: Immunization Date The date vaccination(s) was administered to the patient. Important information for establishing the validity of the immunization records, and therefore mandatory. Also used in the scheduling of subsequent immunizations. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: Immunization masking Indicator Denotes access restriction placed on the immunization record. Methods for accessing masked immunization records will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). The default is 'NORMAL'. Provides support for additional confidentiality constraint to reflect the wishes of the patient. The attribute is optional because not all systems will support masking. | 0-1 | Opt | reasonCode : (ActNoImmunizationReason) Business name: Immunization Refusal Reason A coded value denoting a patient's reason for refusing to be immunized. Typical reasons include: Parental decision, Religious exemption, Patient decision, etc. Useful information for planning future immunization encounters for the patient. | 0-1 | Req | routeCode : (RouteOfAdministration) Business name: Route of Administration This is the means by which the drug was administered to the patient. Ensures consistency in description of routes. Attribute is marked 'optional' to allow for use of pre-coordinated SNOMED Codes. | 0-1 | Opt | approachSiteCode : (HumanSubstanceAdministrationSite) Business name: Administration Site A coded value denoting the body area where the immunization was administered. This is also referred to as the anatomical site of vaccination. Some immunizations are intended to adjust from site to site. (E.g. if first injection is given in right deltoid, first booster should be given in left deltoid.) Attribute is marked 'optional' to allow for use of pre-coordinated SNOMED Codes. | 0-1 | Opt | doseQuantity : PQ.DRUG Business name: Quantity Administered The amount of the vaccine administered to/by the patient. Useful for evaluating reaction and for checking contraindication. | 0-1 | Req | | subject : Subject10 | 1 | Mand | | consumable : Consumable | 0-1 | Req | | informant : Informant | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf3 | 0-1 | Req | | cause : CauseOf | 0-1 | Req |
|
| |
| |
| |
| |
|
|
|
|
|---|
| POIZ_MT060140CA.ImmunizationPeriod |
|---|
value : IVL<TS.FULLDATE> Business name: G:Immunization Period Indicates that the returned records should be filtered to only include those immunizations that occurred within the indicated time-period. This will commonly be used to retrieve 'all immunizations since xxx'. Allows the requester to specify the period of interest for the retrieval of immunization records. Useful for constraining run-away queries. | 1 | Mand |
| | POIZ_MT060140CA.IncludeIssuesIndicator |
|---|
value : Business name: Include Issues Indicator Indicates whether or not issues attached to the immunization record are to be returned along with the detailed information. Allows for the flexibility of omitting/including issues in the retrieval of information for immunization data. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
|
| POIZ_MT060140CA.IncludeNotesIndicator |
|---|
value : Business name: Include Notes Indicator Indicates whether or not notes attached to the immunization record are to be returned along with the detailed information. Allows for the flexibility of omitting/including notes in the retrieval of information for immunization data. The value of this parameter must be known to return a response, so it is marked as mandatory. | 1 | Mand |
| POIZ_MT060140CA.NextPlannedDosePeriod Business name: Next Planned Dose Period |
|---|
value : IVL<TS.FULLDATE> Business name: H:Next Planned Dose Period Indicates that the returned records should be filtered to only include those immunization records for which the next planned dose date falls within the indicated time-period. Allows the requester to specify the period of interest for the retrieval of immunization records. Useful for constraining run-away queries. | 1 | Mand |
|
| | POIZ_MT060140CA.PatientBirthDate |
|---|
value : TS.DATE Business name: D:Patient Birth Date Indicates the date on whic the patient was born. Use to confirm identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| POIZ_MT060140CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: C:Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | POIZ_MT060140CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient immunization query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
|
| POIZ_MT060140CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name of the patient who is the subject of the patient immunization query. Filter the result set to include only those records pertaining to the patient with this name. Allows filtering of result set by patient name. This is a mandatory field because a patient name must match the patient Id for the query to be valid. | 1 | Mand |
| | POIZ_MT060140CA.RenewalPeriod |
|---|
value : IVL<TS.FULLDATE> Business name: I:Renewal Period Indicates that the returned records should be filtered to only include those immunization records for which the renewal date falls within the indicated time-period. Allows the requester to specify the period of interest for the retrieval of immunization records. Useful for constraining run-away queries. | 1 | Mand |
|
| POIZ_MT060140CA.VaccineCode |
|---|
value : (VaccineEntityType) Business name: E:Vaccine Code A coded value indicating a specific vaccine to be used in searching for patient immunization record. The result set will be filtered to only include immunization records involving the specific vaccine code Allows for finer sub-set of immunization records to be retrieved based on the vaccine code used in the immunization. | 1 | Mand |
| | POIZ_MT060140CA.VaccineDoseNumber |
|---|
value : INT.POS Business name: F:Vaccine Dose Number A number representing the vaccine booster order that must be used in searching for patient immunization record. The result set will be filtered to only include immunization records pertaining to specific booster number. Allows for finer sub-set of immunization records to be retrieved based on the sequence of the vaccine booster. | 1 | Mand |
|
|
|
|
|---|
| |
| |
| |
POIZ_MT060150CA.Immunization Business name: Immunizations A record of a patient's immunizations. Necessary component of a person's overall medication profile. Helps deal with outbreaks and also drug contraindication checking. approachSite must be required if not using SNOMED Route must be requires if not using SNOMED If immunization was not refused, then refusal reason must not be specified otherwise field should be treated as populated. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Immunization Record Id This is an identifier assigned to a unique instance of an immunization record. Allows for the unique referencing of a specific immunization record. Thus the mandatory requirement. | 1 | Mand | code : CD (ActCode) Business name: Immunization Type Indicates what type of administration is being performed. Indicates that the type of administration is an administration, and for SNOMED, also indicates the specific type of administration. Therefore, the attribute is mandatory. The attribute is CD to allow for SNOMED post-coordination | 1 | Mand | negationInd : Business name: Not Immunized? An explicit indication that a person has not been immunized with the specified vaccine at the time indicated. Tracking failures to be immunized is also important in immunization reporting. Marked as mandatory because it is not meaningful for this flag to be 'unknown'. NotImmunized CompletionStstus (true = Not administered) | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: C:Immunization Date The date vaccination(s) was administered to the patient. Important information for establishing the validity of the immunization records, and therefore mandatory. Also used in the scheduling of subsequent immunizations. ZDP.13.2.2 ZDP.13.3 ZDP.13.4 ZDP.13.5 | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: D:Immunization Masking Indicator Denotes access restriction place on the immunization record. Provides support for additional confidentiality constraint to reflect the wishes of the patient. The attribute is optional because not all systems will support masking. | 0-1 | Opt | reasonCode : (ActNoImmunizationReason) Business name: Immunization Refusal Reason A coded value denoting a patient's reason for refusing to be immunized. Typical reasons include: Parental decision, Religious exemption, Patient decision, etc Allows sorting and categorizing different kinds of refusal reasons. Ensures that reasons are gathered in a consistent analyzable manner. CompletionStatus (Refused) | 0-1 | Req | routeCode : (RouteOfAdministration) Business name: E:Route of Administration This is the means by which the drug was administered to the patient. Ensures consistency in description of routes. Attribute is marked 'optional' to allow for use of pre-coordinated SNOMED Codes. Route of administration | 0-1 | Opt | approachSiteCode : (HumanSubstanceAdministrationSite) Business name: Administration Site A coded value denoting the body area where the immunization was administered. Some immunizations are intended to adjust from site to site. (E.g. if first injection is given in right deltoid, first booster should be given in left deltoid.) Attribute is marked "optional" to allow for use of pre-coordinated SNOMED Codes. RXR.2 | 0-1 | Opt | doseQuantity : PQ.DRUG Business name: Quantity Administered The amount of the vaccine administered to/by the patient. Useful for evaluating reaction and for checking contraindication. Attribute is populated to allow for situations where quantity may not be known and thus null flavor must be specified. | 1 | Pop | | subject : Subject10 | 1 | Mand | | consumable : Consumable2 | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author | 1 | Mand | | informant : Informant | 0-1 | Req | | location : Location | 1 | Mand | | inFulfillmentOf : InFulfillmentOf3 | 0-1 | Req | | subjectOf1 : Subject6 | 0-25 | Req | | subjectOf2 : Subject9 | 0-99 | Req | | subjectOf3 : Subject | 0-1 | Req | | subjectOf4 : Subject2 | 0-1 | Req | | cause : CauseOf | 0-1 | Req |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
|
|---|
| POME_MT010030CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: B:Drug Code An identifier for a specific drug product. Types of drugs identified by drug code include: Manufactured drug, generic formulation, generic, therapeutic class, etc. Allows the requester to retrieve detail information about a specific drug product. | 1 | Mand |
| POME_MT010030CA.ParameterList Business name: Drug Query Parameters Defines the set of parameters that may be used to filter the query response. Root class for query parameters |
|---|
| drugCode : DrugCode | 1 | Mand |
|
|
|
|
|---|
| |
| |
| POME_MT010040CA.Author Business name: Monograph Source Expresses who is responsible for the content of the monograph Provides a means of evaluating accuracy of the content of the monograph. ZPC1.1(organization.ID) ZPD2.1 |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | assignedEntity : AssignedEntity1 | 1 | Pop |
|
| POME_MT010040CA.Characteristic Business name: Appearance Characteristics The characteristics of a manufactured product that visually distinguish it from other products. Used for searching drugs. May be employed as means of communication between providers and patients. |
|---|
| classCode : "OBS" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (MedicationObservationType) Business name: Characteristic Type A coded value denoting the type of physical characteristic being documented. Kinds of characteristics include: Color, Shape, Markings, Size. Identifies what kind of characteristic is being identified. This is mandatory as providing the characteristic alone without specifying the type can result in ambiguity | 1 | Mand | value : Business name: Characteristic Information pertaining to a specific instance of drug characteristic (color, shape, markings etc) Provides the 'value' part of the name-value pair describing the drug product appearance characteristic. The attribute is marked as 'mandatory' as there must be a value for a mandatory code. | 1 | Mand |
|
| |
POME_MT010040CA.Consumable2 Business name: has Identifies recommended (labeled) routes of administration, maximum/minimum daily dosages, recommended indications and overall use instructions for the drug. Provides guidance to providers regarding how the drug might be used. |
|---|
| typeCode : "CSM" (ParticipationType) | 1 | Mand | | administrationGuideline : AdministrationGuideline | 1 | Pop |
| POME_MT010040CA.Content Business name: dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG Business name: Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 1 | Mand |
|
POME_MT010040CA.Custodian Business name: Monitoring Indicates the organization responsible for instituting the monitoring program. May determine the jurisdiction in which the program is in effect. May also identify the organization which must be reported to. |
|---|
| typeCode : "CST" (ParticipationType) | 1 | Mand | | assignedEntity : AssignedEntity2 | 1 | Pop |
| |
POME_MT010040CA.Document Business name: Monographs Information on the composition and use of a drug. Guides providers for specifying optimum use of drugs by patients. May also guide patients in appropriately using their medication. |
|---|
| classCode : "DOC" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: Monograph Id Unique identifier assigned to a monograph record. Allows matching and replacing of locally-stored monographs. This attribute is marked as 'mandatory', as it is always available. Monograph.monographId | 1 | Mand | code : (ActMedicationDocumentCode) Business name: Monograph Type Distinguishes between different kinds of documents and monographs. Kinds of monographs include: Clinical Monograph, Patient Education Monograph, etc. Allows monograph types to be distinguished for display, printing, etc. Code is mandatory because an application can't know what to do with a monograph without knowing its type. Allows distinction between Drug Monograph and Patient Monograph. ZPC1.2 ZPD2.2 | 1 | Mand | text : ED.DOCORREF Business name: Monograph Content Includes either the full-blown content of the monograph (as a PDF, HTML or HL7 CDA document), or provides a reference to where the monograph can be accessed on the network via HTTP or FTP Allows delivery of the monograph information to the provider either embedded or by reference DrugMonograph.DrugMomographLines PatientMonograph.PatientMonographLines ZPD3.1 | 0-1 | Req | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.DATE> Business name: Monograph Effective/Expiry Date The date on which the information in the monograph became effective, and/or the date on which the information in the monograph was superseded Indicates currency of information or when monograph no longer applies. Different systems may update their monographs at different times, and it is important to know what version contains the most current information. Monograph effective and/or expiry date should be available in most situations and is clinically relevant; thus attribute is marked as 'populated'. Monograph.EffectiveDate Monograph.EndDate | 1 | Pop | languageCode : (HumanLanguage) Business name: Written in A coded value denoting the language in which the monograph is written. Allows providers to request or display monographs in the language of their choice. This attribute is marked as 'populated' because the language of the monograph must always be known/available or a null flavor must be specified. | 1 | Pop | | author : Author | 0-1 | Req |
| |
POME_MT010040CA.Ingredient Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
| classCode : "INGR" (RoleClass) | 1 | Mand | negationInd : Business name: Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. Because product descriptions (particularly herbals) occasionally use the phrase "may contain", this attribute allows null values. | 0-1 | Req | quantity : PQ.DRUG Business name: Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Mand |
| POME_MT010040CA.InitialDispense Business name: Drug Validity Period Defines upper limits for period in which a prescribed drug may be dispensed. Although an attempt will be made to obtain and define panCanadian validity periods for drug, it is possible that drug validity periods wii be jurisdiction-specific Allows for business rules regarding dispenses against a prescription. Controlled and monitored drugs have shorter prescription lifespans that other drugs. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "DEF" (ActMood) | 1 | Mand | effectiveTime : IVL.WIDTH<TS.FULLDATE> Business name: First Fill Period The period within which the prescribed drug has to be dispensed for the first time. This is usually jurisdiction-specific, and for the most part, it is set at the drug class level. For instance, the first fill period of validity for narcotic drugs is 3 days in most jurisdiction, where as it is between 18 and 24 months for other non-controlled drugs. Certain prescribers have time limitations or certain drugs must be filled in a finite period of time. DrugProduct:firstFillPeriod (first occurrence, if multiple) | 1 | Mand |
|
| POME_MT010040CA.ManufacturedProduct Business name: manufactured by Associates a drug product with the organization responsible for producing it. May be important for tracing adverse events and for performing drug searches. |
|---|
| classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturer : Manufacturer | 1 | Mand |
|
POME_MT010040CA.Manufacturer Business name: Manufacturer Identity of the organization that manufactured the drug product. Useful in distinguishing and grouping drug products |
|---|
| classCode : "ORG" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: Manufacturer Id An identifier denoting a specific drug manufacturer. Allows sending of identifiers in place of manufacturer name. May be used in drug search where specific manufacturer is a criterion. | 0-1 | Req | name : Business name: Manufacturer Name The name of the drug manufacturer. Used in reporting. The attribute is marked as "mandatory" because there will always be a name for an organization. DrugProduct.ManufacturerName ZPC.6 RXA.17 C.1c Manufacturer | 1 | Mand |
| POME_MT010040CA.Medication Business name: Medication Represents a particular medicine or herbal product which might be prescribed or administered. Allows retrieval of details about a product at a particular level of granularity (therapeutic class, generic, manufactured, etc.) |
|---|
| classCode : "MED" (RoleClass) | 1 | Mand | | player : Medicine | 1 | Mand | | subjectOf1 : Subject9 | 0-5 | Req | | subjectOf2 : Subject5 | 0-1 | Req | | subjectOf3 : Subject10 | 0-10 | Req | | subjectOf4 : Subject8 | 0-5 | Req | | subjectOf5 : Subject7 | 0-1 | Req | | consumedIn : Consumable2 | 0-10 | Req | | productOf1 : Product2 | 0-1 | Req | | productOf2 : Product | 0-5 | Req |
|
POME_MT010040CA.Medicine Business name: Drug or Compound A catalog of drugs (manufactured material) from which drugs may be selected for prescribing/dispensing. This includes: TC - Therapeutic Class; GD - Generic Drug; GF - Generic Formulation; MD - Manufactured Drug; and CMP - Compound Provides a list of drugs available for prescribing/dispensing. A_BillablePharmacyDispense |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDrug) Business name: Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccines), generic formulation, generic, therapeutic class, etc. Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is mandatory because querying by drug code can only return drug codes. DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Mand | name : SET<TN> Business name: Drug Names The name assigned to a drug. Names are used for human reference communication, to allow selection from dropdowns and for local searching. Up to two names are supported: a 'search name' which is fully formed with no abbreviations, and a 'display name' which may contain abbreviations to fit within a smaller area on the screen. This attribute is marked as 'mandatory' as drugs at any level of the drug hierarchy is supposed to have a name. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1-2 | Mand | desc : Business name: Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | | formCode : (OrderableDrugForm) | 0-1 | Req | | asManufacturedProduct : ManufacturedProduct | 0-1 | Req | | asRegulatedProduct : RegulatedProduct | 0-1 | Req | | asContent : Content | 0-1 | Req | | asSpecializedKind : SpecializedKind | 0-5 | Req | | ingredient : Ingredient | 0-100 | Req |
| POME_MT010040CA.MedicineClass Business name: Drug Categories A categorization system that shows where a drug fits into a hierarchy of drug classification. Examples include: therapeutic class, generic drug, generic formulation, and manufactured drug. Allows filtering and drill-down of drug products, as well as decision making with respect to substitutability, etc. Either a code or name must be specified. |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDrug) Business name: Drug Code A code that uniquely identifiers a drug within a specific drug identification scheme. Used to uniquely identify a particular drug product when prescribing/dispensing at a higher level of abstraction (e.g. generic drug, generic formulation). This attribute is marked as "populated" as drug code should be available in most cases. HICL Therapeutic Class Therapeutic Sub Classification DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) | 1 | Pop | name : Business name: Drug Name The name assigned to a drug within a specific drug identification scheme. To display in dropdowns and for local searching. This attribute is marked as "populated" as a drug name should be available in most cases. Generic Name | 1 | Pop |
|
POME_MT010040CA.MonitoringProgram Business name: Monitoring Programs A system of additional business rules, documentation or reporting associated with a particular drug or group of drugs. These are typically instituted to detect potential abuse, or to monitor prescribing and/or dispensing patterns of a sensitive class of medications. Examples include triplicate programs, antibiotic monitoring programs, etc. Allows association of additional business requirements with a particular drug DrugProduct.triplicate Prescription.triplicate |
|---|
| classCode : "MPROT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActMonitoringProtocolCode) Business name: Program Type A coded value denoting a specific kind of monitoring program. For example, "Drugs of potential abuse", "Antibiotics", etc. Used for classifying and sorting monitoring programs. This is mandatory because, different program types have different business rules. DispensedItem.triplicate | 1 | Mand | title : Business name: Program Name A user-friendly label assigned to the monitoring program. Provides a provider-recognizable label for the program. | 0-1 | Req | | statusCode : "completed" (ActStatus) | 1 | Mand | | custodian : Custodian | 0-1 | Req |
| POME_MT010040CA.ObservationEventCriterion Business name: Patient Characteristics Indicates a characteristic that should be possessed by the patient for the dose to be appropriate. Allows filtering of dosages to be appropriate to the patient. Value should be mandatory if not using SNOMED |
|---|
| classCode : "OBS" (ActClass) | 1 | Mand | | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | code : (ObservationDosageDefinitionPreconditionType) Business name: Patient Characteristic Type Indicates the type of patient characteristic being expressed. E.g. Height, weight, age, lab values, etc. If negation indicator is true, then this indicates a characteristic the patient should *not* have. Needed to identify what type of characteristic is being expressed, and therefore mandatory. | 1 | Mand | negationInd : Business name: Exclude characteristic? If true, indicates that the characteristic is one which should *not* be held by the patient for the dosage to apply. Many dosages are inappropriate for patients with certain characteristics (e.g. INR values, etc.) Because it must be known whether the characteristic is included or excluded, this element is mandatory. | 1 | Mand | value : IVL<PQ.BASIC> Business name: Patient Characteristic Value Indicates the specific value or range of values of the characteristic a patient should have for the dosage to be appropriate. Allows comparison to actual patient characteristics to see if the dosage is applicable. In some circumstances, the specific range may not be known, thus the field is "populated" Example: This dosage specification applies to people over 60 pounds". | 1 | Pop |
|
| |
| |
| |
POME_MT010040CA.Patient Business name: Patient Indicates the type of patient for whom the dosage instruction applies. Important for qualifying and filtering dosage specifications. |
|---|
| classCode : "PAT" (RoleClass) | 1 | Mand | | patientLivingSubjectKind : LivingSubjectKind | 1 | Mand |
| |
POME_MT010040CA.PotentialCharge Business name: Drug Cost Suggested cost of a drug (unit cost). Allows providers to evaluate patient's affordability status before prescribing a drug. |
|---|
| classCode : "INVE" (ActClass) | 1 | Mand | | moodCode : "DEF" (ActMood) | 1 | Mand | unitPriceAmt : MO.CAD Business name: Drug Cost The average unit dose cost of the drug. May influence prescriber and pharmacists decisions as cost can impact compliance. ZPJ2.2 | 1 | Mand |
| POME_MT010040CA.PotentialSupply Business name: Formularies List of drugs available from (or carried by) a particular organization. For example, University Hospital formulary, East Side Long Term Care formulary, Alberta Blue Cross formulary Used to ascertain/ensure what drugs can be prescribed/dispensed within a specific jurisdiction or which will be covered by a patient's insurance. At least One of Id or Title must be specified |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "DEF" (ActMood) | 1 | Mand | id : II Business name: Formulary Id A unique identifier for a specific formulary. Allows the formulary to be unambiguously referenced | 0-1 | Req | title : Business name: Formulary Name The name by which the formulary is commonly known. Gives a provider-recognizable label for the formulary. | 0-1 | Req | | performer : Performer | 0-1 | Req |
|
| POME_MT010040CA.Product Business name: listed in Identifies list of formularies which allow supply of the drug. Formularies may include regulatory formularies, stock formularies (i.e. what medications are typically stocked) and coverage formularies (what medications are typically covered by an insurance program.) Whether a medication is typically available or covered by insurance can have a significant influence on the likelihood of a patient complying with administration instructions. Therefore it becomes an important consideration for prescribing |
|---|
| typeCode : "PRD" (ParticipationType) | 1 | Mand | | potentialSupply : PotentialSupply | 1 | Pop |
|
POME_MT010040CA.Product2 Business name: *has This indicates the first fill and refill period requirements fo the drug Used to enforce dispensing business rules for the drug. |
|---|
| typeCode : "PRD" (ParticipationType) | 1 | Mand | | dispenseGuidelines : DispenseGuidelines | 1 | Pop |
| |
POME_MT010040CA.RegulatedProduct This element is mandatory for DIN-level drugs, not used elsewhere. |
|---|
| classCode : "RGPR" (RoleClass) | 1 | Mand | statusCode : (RoleStatusNormal) Business name: Regulatory Status Code Indicates whether the drug is approved for use in Canada or not. (active = currently approved, terminated or pending = not approved) Allows providers to evaluate the validity of the medication for use in Canada. | 1 | Mand |
| POME_MT010040CA.SpecializedKind Business name: grouped within Indicates the location of a medication in a particular abstract hierarchy. For example, what generic, generic formulation, or therapeutic class does the medication fall into. Exposes the drug hierarchy, allowing drill-down when prescribing and dispensing. Also indicates possibilities for substitution and can be important for detecting interactions such as allergies or duplicate therapy between closely-related drugs. Shows relationship between GenericDrugproduct, Generic FormulationDrugProduct and ManufacturedDrugProduct ZPC.7(query will reference the generic equivalency relationship in defining the boolean query parameter) |
|---|
| classCode : "GEN" (RoleClass) | 1 | Mand | code : (MedicationGeneralizationRoleType) Business name: Drug Category Code A coded value denoting a specific level in the hierarchical definition of drugs. Describes the relationship between two levels of drug products (e.g. Drug A is the generic for Drug B) | 0-1 | Req | | generalizedMedicineClass : MedicineClass | 1 | Mand |
|
| POME_MT010040CA.Subject10 Business name: distinguished by Indicates the physical appearance characteristics of the drug, such as size, color, shape, markings, etc. Patients are often unfamiliar with the names of their medications, but can describe them by appearance. At the same time, prescribers may be familiar with the name but not the appearance. This information eases communication between provider and patient and also may be used to search for a particular drug product by appearance characteristics |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | characteristic : Characteristic | 1 | Pop |
|
POME_MT010040CA.Subject5 Business name: Half-life Identifies the length of time a drug may be active is a patient's system after administration has ended. Useful and necessary information for contraindication checking. |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | halfLife : HalfLife | 1 | Pop |
| |
POME_MT010040CA.Subject8 Business name: subject to Indicates which drugs are subject to a particular monitoring or reporting program. Examples of monitoring programs include 'triplicate' programs for narcotics or drugs of potential abuse; special reporting requirements for anti-biotic prescribing, etc. Useful in implementing program-specific business rules for prescribing/dispensing. |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | monitoringProgram : MonitoringProgram | 1 | Pop |
| POME_MT010040CA.Subject9 Business name: described by Provides detailed written information about the characteristics and use of the drug. Different types of monographs may be available, including patient monographs (providing guidance to a patient taking the medication), manufacturer's monographs (providing technical information to prescribers and pharmacists) and clinical practice guidelines providing recommendations from practice groups or regulatory bodies. Monographs provide additional background information in an 'un-coded' manner intended to be easy to scan and read. Patient monographs allow prescribers and pharmacists to easily distribute relevant educational information. |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | document : Document | 1 | Pop |
|
| POME_MT010040CA.Substance Business name: Drug Ingredients A list of drugs or raw chemicals that may be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Either a code or name must be specified. |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType) Business name: Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as specific class of ingredients in vaccines. This attribute is marked as "populated" as an ingredient code should be available in most cases. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 1 | Pop | name : Business name: Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. This attribute is marked as "populated" as an ingredient name should be available in most cases. CompoundIngredient.IngredientDrug.drugProductName | 1 | Pop |
|
|
|
|
|---|
| POME_MT010050CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: B:Drug Code An identifier for a type of drug. Types of drugs include: Manufactured drug, generic formulation, generic, therapeutic class, etc. Allows the requester to retrieve drugs of certain abstraction only. These drug abstractions include: Manufactured drug, generic formulation, generic, therapeutic class, etc. | 1 | Mand |
| | POME_MT010050CA.MedicationDocumentID |
|---|
value : II Business name: E:Medication Document ID Unique identifier for a particular medication document. This will reference a specific kind of documentation (e.g. DDI Monograph, Patient Education Monograph, Allergy Monograph, etc) created by a specific author organization (e.g. Health Canada, FDB, WHO, etc). Use of an identifier allows for a quick retrieval of the information of interest. | 1 | Mand |
|
| POME_MT010050CA.MedicationDocumentType |
|---|
value : (ActMedicationDocumentCode) Business name: D:Medication Document Type Indicates that the result set is to be filtered to include only those medication documents pertaining to the specified document category. Valid medication document categories include: Drug Monograph, Contraindication Monograph, Indication Protocol, etc. Allows for the retrieval of all medication documents pertaining to a specific document category. | 1 | Mand |
| |
| POME_MT010050CA.PrescribingDiagnosisCode |
|---|
value : (DiagnosisValue) Business name: C:Prescribing Indication Diagnosis Code Returns documents which relate to a particular diagnosis Useful for finding protocols and drug monographs associated with an indication | 1 | Mand |
| | POME_MT010050CA.PrescribingSymptomCode |
|---|
value : (SymptomValue) Business name: Prescribing Indication Symptom Code Returns documents which relate to a particular symptom Useful for finding protocols and drug monographs associated with an indication | 1 | Mand |
|
|
|
|
|---|
| POME_MT010090CA.DrugCharacteristic |
|---|
value : Business name: G:Drug Characteristic Information pertaining to a specific instance of drug characteristic (color - red, shape - triangular, markings etc). Provides the 'value' part of the name-value pair describing the characteristic of drug product to be retrieved. Example: type: color value: blue type: shape value: rectangular The attribute is mandatory because there's no point searching for a characteristic without specifying a value. | 1 | Mand |
| POME_MT010090CA.DrugCharacteristicType Business name: Characteristics Indicates the characteristic to be searched by. Allows searching by appearance characteristics of the drug. |
|---|
value : (QueryParameterValue) Business name: H:Drug Characteristic Type Code A coded value denoting the type of physical characteristic of a drug. Characteristics include: Color, Shape, Markings, Size, etc. Allows retrieval based on specific characteristic of a drug. The attribute is mandatory because there's no point searching for a characteristic without identifying what kind of characteristic is being searched by. | 1 | Mand |
|
| | POME_MT010090CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: B:Drug Code An identifier that describes a drug at any level of the clinical drug hierarchy. The code may describe (point to) a Manufactured drug, generic drug formulation, generic drug, therapeutic classification, etc. For example, using a therapeutic class code in the DrugCode parameter would return a list of all drugs that are within that class. Sending a drug name in the DrugName parameter would return a list of all drugs that have that name e.g. sending acetaminophen would return all of the acetaminophen products in the drug data base. By including the DoseForm, DoseRoute, DrugManufacturerName or DrugCharacteristic, the list could be further constrained. Allows the requester to retrieve drugs of certain abstraction only. These drug abstractions include: Manufactured drug, generic formulation, generic, therapeutic class, etc. | 1 | Mand |
|
| | POME_MT010090CA.DrugManufacturerName |
|---|
value : Business name: F:Drug Manufacturer Name The name of a drug manufacturer. Manufacturer name search will be 'Starts with...' type of a search. Allows for the retrieval of drug products based on the manufacturer. | 1 | Mand |
|
| POME_MT010090CA.DrugName |
|---|
value : Business name: C:Drug Name The name assigned to a drug. Name may be the only identification of a drug known by many prescribers. | 1 | Mand |
| | POME_MT010090CA.DrugRoute |
|---|
value : (QueryParameterValue) Business name: E:Drug Route Code A filter based on how the drug should be introduced into the patient's body (e.g. Oral, topical, etc.) Allows limiting the returned list of drugs to a single route. | 1 | Mand |
|
|
|
|
|
|---|
POME_MT010100CA.Characteristic Business name: Appearance Characteristics The characteristics of a manufactured product that visually distinguish it from other products. Used for searching drugs. May be employed as means of communication between providers and patients. |
|---|
| classCode : "OBS" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (MedicationObservationType) Business name: A:Characteristic Type A coded value denoting the type of physical characteristic being documented. Kinds of characteristics include: Color, Shape, Markings, Size, etc. Identifies what kind of characteristic is being identified. This is mandatory as providing the characteristic alone without specifying the type can result in ambiguity. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | value : Business name: E:Characteristic Information pertaining to a specific instance of drug characteristic (color, shape, markings etc). Provides the 'value' part of the name-value pair describing the drug product appearance characteristic. The attribute is marked as "mandatory" as there must be a value for a mandatory code. | 1 | Mand |
| POME_MT010100CA.Content Business name: dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense |
|---|
| classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG Business name: Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 1 | Mand |
|
POME_MT010100CA.Ingredient Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
| classCode : "INGR" (RoleClass) | 1 | Mand | negationInd : Business name: L:Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. Because product descriptions (particularly herbals) occasionally use the phrase "may contain", this attribute allows null values. | 0-1 | Req | quantity : PQ.DRUG Business name: M:Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Mand |
| POME_MT010100CA.ManufacturedProduct Business name: manufactured by Associates a drug product with the organization responsible for producing it. May be important for tracing adverse events and for performing drug searches. |
|---|
| classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturer : Manufacturer | 1 | Mand |
|
POME_MT010100CA.Manufacturer Business name: Manufacturer Identity of the organization that manufactured the drug product. Useful in distinguishing and grouping drug products |
|---|
| classCode : "ORG" (EntityClass) | 1 | Mand | | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II Business name: Organization Id An identifier denoting a specific drug manufacturer. Allows sending of identifiers in place of manufacturer name. May be used in drug search where specific manufacturer is a criterion. | 0-1 | Req | name : Business name: Manufacturer Name The name of the drug manufacturer. Used in reporting. The attribute is marked as "mandatory" because there will always be a name for an organization. | 1 | Mand |
| POME_MT010100CA.Medication Business name: Medication Represents a particular medicine or herbal product which might be prescribed or administered. Allows retrieval of summary about one or more products when searching for a medication |
|---|
| classCode : "MED" (RoleClass) | 1 | Mand | | player : Medicine | 1 | Mand | | subjectOf1 : Subject7 | 0-1 | Req | | subjectOf2 : Subject10 | 0-10 | Req |
|
| POME_MT010100CA.MedicineClass Business name: Drug Categories A categorization system that shows where a drug fits into a hierarchy of drug classification. Examples include: therapeutic class, generic drug, generic formulation, and manufactured drug. Allows filtering and drill-down of drug products, as well as decision making with respect to substitutability, etc. At least one of drug code or drug name must be specified. |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDrug) Business name: Drug Code An identifier for a drug at a higher level of abstraction. Used to uniquely identify a particular drug product when prescribing/dispensing at a higher level of abstraction (e.g. generic drug, generic formulation). This attribute is marked as "populated" as a drug code should be available in most cases. HICL Therapeutic Class Therapeutic Sub Classification DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) | 1 | Pop | name : Business name: Drug Name The name assigned to the drug at the higher level of abstraction. To display in dropdowns and for local searching. This attribute is marked as "populated" as drug name should be available in most cases. Generic Name | 1 | Pop |
|
| POME_MT010100CA.PotentialCharge Business name: I:Drug Cost Suggested cost of a drug (unit cost). Allows providers to evaluate patient's affordability status before prescribing a drug. |
|---|
| classCode : "INVE" (ActClass) | 1 | Mand | | moodCode : "DEF" (ActMood) | 1 | Mand | unitPriceAmt : MO.CAD Business name: I:Drug Cost The average unit dose cost of the drug. May influence prescriber and pharmacists decisions as cost can impact compliance. ZPJ2.2 | 1 | Mand |
|
POME_MT010100CA.RegulatedProduct This element is mandatory for DIN-level drugs, not used elsewhere. |
|---|
| classCode : "RGPR" (RoleClass) | 1 | Mand | statusCode : (RoleStatusNormal) Business name: Regulatory Status Code Indicates whether the drug is approved for use in Canada or not. (active = approved for use; pending or terminated = not approved for use) Allows providers to evaluate the validity of the medication for use in Canada. | 1 | Mand |
| POME_MT010100CA.SpecializedKind Business name: grouped within Indicates the location of a medication in a particular abstract hierarchy. For example, what generic, generic formulation, or therapeutic class does the medication fall into. Exposes the drug hierarchy, allowing drill-down when prescribing and dispensing. Also indicates possibilities for substitution and can be important for detecting interactions such as allergies or duplicate therapy between closely-related drugs. Shows relationship between GenericDrugproduct, Generic FormulationDrugProduct and ManufacturedDrugProduct ZPC.7(query will reference the generic equivalency relationship in defining the boolean query parameter) |
|---|
| classCode : "GEN" (RoleClass) | 1 | Mand | code : (MedicationGeneralizationRoleType) Business name: Drug Category Code A coded value denoting a specific level in the hierarchical definition of drugs. Describes the relationship between two levels of drug products (e.g. Drug A is the generic for Drug B) | 0-1 | Req | | generalizedMedicineClass : MedicineClass | 1 | Mand |
|
POME_MT010100CA.Subject10 Business name: distinguished by Indicates the physical appearance characteristics of the drug, such as size, color, shape, markings, etc. Patients are often unfamiliar with the names of their medications, but can describe them by appearance. At the same time, prescribers may be familiar with the name but not the appearance. This information eases communication between provider and patient and also may be used to search for a particular drug product by appearance characteristics. |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | characteristic : Characteristic | 1 | Pop |
| |
POME_MT010100CA.Substance Business name: Drug Ingredients A list of drugs or raw chemicals that may be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. At least one of ingredient code or ingredient name must be specified. |
|---|
| classCode : "MMAT" (EntityClass) | 1 | Mand | | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType) Business name: J:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as class of ingredients in vaccines. This attribute is marked as "populated" as an ingredient code should be available in most cases. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 1 | Pop | name : Business name: K:Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. This attribute is marked as "populated" as an ingredient name should be available in most cases. CompoundIngredient.IngredientDrug.drugProductName | 1 | Pop |
|
|
|
|
|---|
| PORR_MT050016CA.Author Business name: Monograph Source Expresses who is responsible for the content of the monograph Provides a means of evaluating accuracy of the content of the monograph. ZPC1.1(organization.ID) ZPD2.1 |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | assignedEntity : AssignedEntity | 1 | Pop |
|
| PORR_MT050016CA.Document Business name: Medication Documents Information on the composition and use of a drug. Guides providers for specifying optimum use of drugs by patients. May also guide patients in appropriately using their medication. |
|---|
| classCode : "DOC" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: B:Medication Document Id Unique identifier assigned to a medication document record. Allows matching and replacing of locally-stored medication documents. This attribute is marked as 'mandatory', as it is always available. Monograph.monographId | 1 | Mand | code : (ActMedicationDocumentCode) Business name: A:Medication Document Type Distinguishes between different kinds of documents and medication documents. Kinds of medication documents include: Clinical Medication document, Patient Education Medication document, Indication Protocol, etc Allows medication document types to be distinguished for display, printing, etc. Code is mandatory because an application can't know what to do with a medication document without knowing its type. Allows distinction between Drug Monograph and Patient Monograph. ZPC1.2 ZPD2.2 | 1 | Mand | effectiveTime : IVL<TS.DATE> Business name: C:Medication Document Effective/Expiry Date The date on which the information in the medication document became effective, and/or the date on which the information in the medication document was superseded. Indicates currency of information or when monograph no longer applies. Different systems may update their monographs at different times, and it is important to know what version contains the most current information Monograph effective and/or expiry date should be available in most situations and is clinically relevant; thus attribute is marked as 'populated'. Monograph.EffectiveDate Monograph.EndDate | 1 | Pop | | author : Author | 0-1 | Req | | component : Component | 1 | Mand |
|
| PORR_MT050016CA.DocumentBodyEvent |
|---|
| classCode : "DOCBODY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | text : ED.DOCORREF Business name: F:Medication Document Content + Language Includes either the full-blown content of the medication document (as a PDF, HTML or HL7 CDA document), or provides a reference to where the medication document can be accessed on the network via HTTP or FTP. This attribute will also include a coded value denoting the language in which the medication document is written. Allows delivery of the medication document information to the provider either embedded or by reference. The inclusion of document language allows providers to determine what language the medication document is written in. The attribute is mandatory because there is no point in having a medication document with no content. | 1 | Mand |
| |
|
|
|
|---|
PORX_MT010110CA.Author Business name: Payor This is the plan provider (the payor) who is reponsible for evaluating and approving the coverage extension. Establishes financial responsibility for the prescription as well as provide a means for the provider to engage in follow-up communication with the payor. The payor for coverage extension must be known, thus this is a mandatory requirement. ZDP.23.1 Claim.463-EW (Id.route) Claim.464-EX (Id.extension) |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | underwriter : Underwriter | 1 | Mand |
| |
| PORX_MT010110CA.Coverage Business name: Coverage Extensions An authorization issued by a payor to cover a device not previously covered by a patient's drug plan. Allows conveying special coverage information between providers. |
|---|
| classCode : "COV" (ActClass) | 1 | Mand | moodCode : (x_ActMoodOrderEvent) Business name: Extension Granted Indicator If set to 'EVN', then coverage has been requested. Otherwise it has merely been requested. Indicates to the pharmacy whether they need to check the status of coverage prior to dispensing | 1 | Mand | id : II Business name: A:Coverage Extension Id Unique identification for a specific coverage extension. Allows for referencing of a specific coverage extension. This identifier may be needed on claims against the coverage. At times the ID will not be available (such as when the request has just been submitted), the attribute is 'populated'. D64 Claim.462-EV ZDP.23.3 Authorization identifier | 1 | Pop | | author : Author | 1 | Mand |
|
| |
PORX_MT010110CA.DeviceRequest Business name: Prescription Information pertaining to a prescriber's authorization for a device to be dispensed to a patient, as well as the instruction on when and how the device is to be used by the patient This is a 'core' class of the medication model and is important for understanding what devices the patient is intended to be receiving. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A: Prescription Number The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Allows for the situations where the order is originating from the DIS. Allows prescriptions to be uniquely referenced. Because this attribute is not used for prescriptions originating from a prescriber system, the element is optional. | 0-1 | Opt | statusCode : (ActStatus) Business name: C:Prescription Status This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: new, active, suspended, aborted, completed, obsolete and nullified. Use 'active' when registering a new prescription or converting a predetermination into a valid prescription. Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: F:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their prescription data. The attribute is optional because not all systems will support masking. Prescription.masked | 0-1 | Opt | | subject : Subject5 | 1 | Mand | | directTarget : DirectTarget | 1 | Mand | | predecessor : Predecessor | 0-1 | Req | | reason : Reason2 | 1-5 | Pop | | precondition : Precondition | 0-1 | Req | | coverage : Coverage2 | 0-5 | Req | | component1 : Component1 | 0-1 | Req | | component2 : Component6 | 1 | Mand | | subjectOf : Subject4 | 0-1 | Req |
| |
PORX_MT010110CA.Location2 Business name: *c:targeted to pharmacy Indicates the pharmacy to which the prescription has been directed or which has currently assumed responsibility for dispensing the prescription. Allows prescriptions to be directed on the request of the patient or by legal requirement. Also allows indication of which pharmacy is the current 'custodian' of the prescription. This should always be known or should have an explicit null flavor of 'NA' (non-assigned) or 'UNK' (paper prescription). Thus the association is 'populated'. |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : IVL.LOW<TS.FULLDATE> Business name: to be picked up when The date and time on which the dispense is expected to be picked up. Allows a prescriber to indicate to the targeted pharmacy, when patient will be expecting to pick up the dispensed device. | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| |
| PORX_MT010110CA.PriorDeviceRequest |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: B:Previous Prescription Order Number A reference to a previous prescription which the current prescription replaces. Allows a prescription renewal (this prescription) to note the previous prescription id that was renewed; Allows tracking a therapy across multiple renewal prescriptions. New or Repeat (if present, then Repeat) | 1 | Mand |
| |
PORX_MT010110CA.Reason2 Business name: *d:has prescribing reasons Denotes the reason(s) for this specific prescription; it must not be interpreted as a permanent diagnosis. Helps providers evaluate the appropriateness of the instructions for the device, and may influence education or literature provided to the patient on the use of the device. Provided at the discretion of the prescriber to enhance patient care. This field is marked as populated because of its high clinical importance, however 'Nulls' are allowed because the individual recording the prescription (e.g. pharmacist) may not be aware of the indication or the prescriber may choose to withhold (mask) the information due to patient sensitivity. |
|---|
| typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | priorityNumber : INT.POS Business name: B:Indication Priority Ordering of prescribing indications from primary indication (low number) to minor indication (higher number). Multiple indications are permitted to have the same priority if they're considered of equivalent importance. Allows providers to indicate whether indication is the primary or secondary target of the therapy. E.g., Terazosin for Benign Prostatic Hypertrophy as primary and Hypertension as secondary or vice-versa. | 0-1 | Req | | Choice: indications : Indications | 1 | Pop | | »» observationDiagnosis : ObservationDiagnosis | 0-1 | Opt | | »» observationSymptom : ObservationSymptom | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
| | PORX_MT010110CA.ServiceDeliveryLocation |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: H:Prescription Ship to Address Indicates the location the dispensed device should be shipped to, at the request of the patient or provider. In some cases devices need to be delivered to the patient instead of being picked up. In other cases, devices need to be shipped to the physician's office to replace stock used for the patient. | 1 | Mand |
|
| |
PORX_MT010110CA.SupplyRequest Business name: Dispense Instructions Specification of how the prescribed device is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the device to the patient. A_BillablePharmacyDispense One of 'quantity' and 'expectedUseTime' must be specified |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | quantity : INT.POS Business name: B:Total Prescribed Quantity The overall number of devices to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Sets upper limit for device to be dispensed. Can be used to verify the intention of the prescriber with respect to the overall prescription. Used for comparison when determining whether additional quantity may be dispensed in the context of a part-fill prescription. | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: C:Total Days Supply The number of days that the overall prescribed item is expected to last, if the patient is compliant with the dispensing and use of the prescription. Used to specify a total authorization as a duration rather than a quantity with refills. E.g. dispense 30 at a time, refill for 1 year. May also be sent as an estimate of the expected overall duration of the prescription based on the quantity prescribed. | 0-1 | Req | | destination : Destination1 | 0-1 | Req | | location : Location2 | 1 | Pop |
| | PORX_MT010110CA.Underwriter |
|---|
| classCode : "UNDWRT" (RoleClass) | 1 | Mand | id : II Business name: B:Payor Identifier A unique identifier for the payor organization responsible for the coverage extension. Gives context to the coverage extension identifier and therefore mandatory. Allows the dispensing service delivery location to know where to send a claim. | 1 | Mand | | underwritingOrganization : Organization | 1 | Mand |
|
|
|
|
|
|---|
| PORX_MT010120CA.CombinedMedicationRequest Business name: Prescription Information pertaining to a prescriber's authorization for a drug to be dispensed to a patient, as well as the instruction on when and how the drug is to be consumed by the patient This is a 'core' class of the medication model and is important for understanding what drugs the patient is intended to be receiving. Id should not be specified if the order is being sent by prescriber; Id is mandatory if the order is being sent by the DIS |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Number The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Allows for the situations where the order is originating from the DIS. Allows prescriptions to be uniquely referenced. Because this attribute is not used for prescriptions originating from a prescriber system, the element is optional. | 0-1 | Opt | code : (ActCode) Business name: Prescription Type Indicates that this is a prescription for a drug as opposed to an immunization. For SNOMED, may also contain information regarding drug and route. Needed to convey the meaning of this class and is therefore mandatory. | 1 | Mand | statusCode : (ActStatus) Business name: C:Prescription Status This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: new, active, suspended, aborted, completed, obsolete and nullified. Use 'new' when submitting a clinical pre-determination. Use 'active' when registering a new prescription or converting a predetermination into a valid prescription. Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: F:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their medication data. The attribute is optional because not all systems will support masking. Prescription.masked | 0-1 | Opt | | subject : Subject5 | 1 | Mand | | directTarget : DirectTarget | 0-1 | Req | | definition : Definition | 0-5 | Req | | predecessor : Predecessor | 0-1 | Req | | reason : Reason2 | 1-5 | Pop | | precondition : Precondition | 0-1 | Req | | coverage : Coverage2 | 0-5 | Req | | pertinentInformation : PertinentInformation | 0-6 | Req | | component1 : Component1 | 1-10 | Mand | | component2 : Component2 | 1 | Mand | | component3 : Component6 | 1 | Pop | | subjectOf1 : Subject | 0-1 | Req | | subjectOf2 : Subject4 | 0-1 | Req | | componentOf : Component4 | 1 | Pop |
|
| |
| |
| |
| PORX_MT010120CA.Coverage Business name: Coverage Extensions An authorization issued by a payor to cover a drug not previously covered by a patient's drug plan. Allows conveying special coverage information between providers. |
|---|
| classCode : "COV" (ActClass) | 1 | Mand | moodCode : (x_ActMoodOrderEvent) Business name: Extension Granted Indicator If set to 'EVN', then coverage has been requested. Otherwise it has merely been requested. Indicates to the pharmacy whether they need to check the status of coverage prior to dispensing. The attribute is mandatory due to HL7 rules. | 1 | Mand | id : II Business name: A:Coverage Extension Id Unique identification for a specific coverage extension. Allows for referencing of a specific coverage extension. This identifier may be needed on claims against the coverage. At times the ID will not be available (such as when the request has just been submitted), the attribute is 'populated'. D64 Claim.462-EV ZDP.23.3 Authorization identifier | 1 | Pop | | author : Author | 1 | Mand |
|
| |
| |
PORX_MT010120CA.InitialSupplyRequest Business name: First Fill Special instructions regarding the very first supply of medication to a patient. Allows a different amount to be dispensed on an initial fill, either as a trial or to synchronize refill dates across multiple patient prescriptions. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: First Fill Expiry Date The last date before which an initial dispense can be made against the prescription. If an initial fill has not been made against the prescription in this time-period, then the prescription is no longer deemed valid and it may not be dispensed. Some jurisdictions have distinct stale-date periods for the initial fill of a prescription from the overall dispensing of the prescription. E.g. "The first fill must be made within 1 year, all fills must be complete within 1.5 years". (This attribute would be used for the "1 year"). | 0-1 | Req | quantity : PQ.DRUG Business name: First Fill Quantity The quantity of medication to be dispensed the first time the prescription is dispensed against. Allows a limited quantity to be dispensed for a trial or for a synchronizing dose. Prescription.coordinatingAmount | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: First Fill Days Supply The number of days that the first fill is expected to last, if the patient is compliant with the dispensing of the first fill and with administration of the prescription. Used when the prescriber cannot or does not wish to calculate the quantity necessary to last for the trial or synchronization time. | 0-1 | Req |
| PORX_MT010120CA.Location2 Business name: *c:targeted to pharmacy Indicates the pharmacy to which the prescription has been directed or which has currently assumed responsibility for dispensing the prescription. Allows prescriptions to be directed on the request of the patient or by legal requirement. Also allows indication of which pharmacy is the current 'custodian' of the prescription. This should always be known or should have an explicit null flavor of 'NA' (non-assigned) or 'UNK' (paper prescription). Thus the association is 'populated'. |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : IVL.LOW<TS.FULLDATE> Business name: to be picked up when The date and time on which the dispense is expected to be picked up. Allows a prescriber to indicate to the targeted pharmacy, when patient will be expecting to pick up the dispensed medication. | 0-1 | Req | substitutionConditionCode : (x_SubstitutionConditionNoneOrUnconditional) Business name: Dispense Facility Not Reassignable Indicates a 'hard' or 'soft' assignment of dispensing priviledged to the targetted facility. 'Hard' assignment (mandated facility) indicates that the prescription can be dispensed only at that facility. 'Soft' assignment (usually as a patient directive) indicates that the prescription may be dispensed at facilities other than the targeted facility. Influences whether the prescription may be transferred to a service delivery location other than the targeted dispenser. | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
| |
PORX_MT010120CA.QuantityObservationEvent Business name: Prescription Patient Measurements This comprises the height and/or weight of a patient as measured/observed/known by the prescriber at the time of prescribing. Allows patient height and weight to be conveyed to the pharmacy for dosage calculation or verification; |
|---|
| classCode : "OBS" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (x_ActObservationHeightOrWeight) Business name: Prescription Patient Measurement Type Identification of the type of measurement/observation that was made about the patient. The only two allowable types are height and weight. Distinguishes what kind of information is being specified. Code is mandatory to ensure that measurements/observations are distinguishable. OBS.010-01 NCPDP:Clinical.495-H2 | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: Prescription Patient Measurement Timestamp The date on which the measurement was made Allows providers to evaluate currency of the information. Because the date of measurement determines the relevance of the information, this attribute is defined as 'populated'. OBS.010-04 NCPDP:Clinical.494-ZE NCPDP:Clinical.495-H1 | 1 | Pop | value : PQ.HEIGHTWEIGHT Business name: Prescription Patient Measured Value The amount (quantity and unit) that has been recorded for the specific type of observation. E.g. height in meters, weight in kilograms. Provides comparable representation of the measurement. May be used in calculations. Attribute is defined as 'mandatory' to ensure that a value is supplied, if there is a measurement. OBS.010-02 (quantity) eScript:OBS.010-03 (unit) NCPDP:Clinical.595-H4 (value) NCPDP:Clinical.495-H3 (unit) | 1 | Mand |
| PORX_MT010120CA.Reason2 Business name: *d:has prescribing reasons Denotes the reason(s) for this specific prescription; it must not be interpreted as a permanent diagnosis. Helps providers evaluate the appropriateness of the dosage instructions for the medication, and may influence education or literature provided to the patient on the use of the medication. Provided at the discretion of the prescriber to enhance patient care. E.g., take 1 tab bid for migraine. Also needed for drug-disease interaction checking software to work properly. This field is marked as populated because of its high clinical importance, however 'Nulls' are allowed because the individual recording the prescription (e.g. pharmacist) may not be aware of the indication or the prescriber may choose to withhold (mask) the information due to patient sensitivity. |
|---|
| typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | priorityNumber : INT.POS Business name: B:Indication Priority Ordering of prescribing indications from primary indication (low number) to minor indication (higher number). Multiple indications are permitted to have the same priority if they're considered of equivalent importance. Allows providers to indicate whether indication is the primary or secondary target of the therapy. E.g., Terazosin for Benign Prostatic Hypertrophy as primary and Hypertension as secondary or vice-versa. | 0-1 | Req | | Choice: indications : Indications | 1 | Pop | | »» observationDiagnosis : ObservationDiagnosis | 0-1 | Opt | | »» observationSymptom : ObservationSymptom | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
|
| | PORX_MT010120CA.ServiceDeliveryLocation |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: H:Prescription Ship to Address Indicates the location the dispensed medication should be shipped to, at the request of the patient or provider. In some cases drugs need to be delivered to the patient instead of being picked up. In other cases, drugs need to be shipped to the physician's office to replace stock used for the patient. | 1 | Mand |
|
| |
| | PORX_MT010120CA.SubsequentSupplyRequest |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | effectiveTime : IVL.WIDTH<TS.FULLDATE> Business name: F:Dispense Interval Indicates a minimum amount of time that must occur between dispenses. Helps the prescriber ensure that the patient does not ever receive more than the appropriate amount of medication in a particular timeframe. | 0-1 | Req | repeatNumber : INT.POS Business name: G:Number of Fills The number of times the prescribed quantity is to be dispensed including the initial standard fill. Used to calculate total prescribed quantity; and also used for compliance checking. Expressed as Number of Fills rather than number of refills due to HL7 modeling constraints. D54.03 DRU.060-02 Claim.415-DF ZDP.15.1 Prescription.numberOfRefills | 0-1 | Req | quantity : PQ.DRUG Business name: D:Fill Quantity The amount of medication to be dispensed to the patient for each normal fill (excluding trial or other special first fills). Limits the quantity of medication in patient's possession at a time. Used in compliance checking. Quantity Prescription.fillAmount Prescription.maximumDispensedAmount (when SupplyRequest.effectiveTime id populated with an interval) | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: E:Days Supply The number of days that each standard fill is expected to last. The dispenser must use the administration instructions together with the Days Supply to calculate the total quantity to dispense per fill. May be specified in addition to quantity to indicate the length of time a quantity of "as needed" medication is expected to last. Useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Also provides guidance to the pharmacy on how much to dispense. Also useful in research | 0-1 | Req |
|
| PORX_MT010120CA.SubstitutionPermission Business name: Allowed Substitution A prescriber's instruction that a specific prescribed product be dispensed as is, or not. May have financial and therapeutic conformance ramifications for a patient. A_BillablePharmacyDispense |
|---|
| classCode : "SUBST" (ActClass) | 1 | Mand | | moodCode : "PERM" (ActMood) | 1 | Mand | | code : "G" (ActCode) | 1 | Mand | negationInd : Business name: A:Substitution Not Allowed? If true, indicates that the prescriber has prohibited substitution. Default is that substitution is allowed. Indicates whether substitutions are allowed. The attribute is mandatory because whether substitution is allowed must be declared. Prescription.substitutionAllowed | 1 | Mand | reasonCode : (SubstanceAdminSubstitutionNotAllowedReason) Business name: B:Substitution Not Allowed Reason The reason why the prescriber has indicated that substitution is not allowed by the dispensing pharmacy. Some jurisdictions demand that a prescriber gives a reason for prohibiting substitution. The field is marked as 'Populated' because the reason for substitution is important to understanding the decision. However when a prescription is being recorded in the pharmacy, the information may not be available. | 1 | Pop |
|
PORX_MT010120CA.SupplyRequest Business name: Dispense Instructions Specification of how the prescribed medication is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the medication to the patient. A_BillablePharmacyDispense |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: A:Dispensing Allowed Period This indicates the validity period of a prescription (stale dating the Prescription). It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Prescription Effective Period signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. Indicates when the Prescription becomes valid, and when it ceases to be a dispensable Prescription. Some jurisdictions place a 'stale date' on prescriptions that cause them to become invalid a certain amount of time after they are written. This time may vary by medication. ZPB3.9 DRU.040-02 (low, qualifier=07, format=102) eScript:DRU.040-02 (low, qualifier=36, format=102) HC-SA:Number of days (width) HC-SA:When will drug be administered?(low) PECS:ZDP.17 (high) PEI:Last date dispensed(when summary type is 'most recent') Prescription.dispensingInterval(period) Prescription.effectiveDate (low) PIN:Prescription.expiryDate (high) | 0-1 | Req | | receiver : Receiver | 0-5 | Req | | destination : Destination1 | 0-1 | Req | | location : Location2 | 1 | Pop | | component : Component | 1-5 | Mand |
| PORX_MT010120CA.SupplyRequestItem Business name: Drug Dispense Instructions Specification of the overall use duration of the prescrbed medication and/or overall quantity to be dispensed. Sets the parameters within which the dispenser must operate in dispensing the medication to the patient. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | quantity : PQ.DRUG Business name: B:Total Prescribed Quantity The overall amount of amount medication to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Sets upper limit for medication to be dispensed. Can be used to verify the intention of the prescriber with respect to the overall medication. Used for comparison when determining whether additional quantity may be dispensed in the context of a part-fill prescription. Narcotics must always be specified as a total. | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: A:Total Days Supply The number of days that the overall prescribed item is expected to last, if the patient is compliant with the dispensing and administration of the prescription. Used to specify a total authorization as a duration rather than a quantity with refills. E.g. dispense 30 at a time, refill for 1 year. May also be sent as an estimate of the expected overall duration of the prescription based on the quantity prescribed. This attribute is mandatory because the prescriber (in discussion with the patient) has a better understanding of the days supply needed by the patient. | 1 | Mand | | product : Product1 | 0-1 | Req | | component1 : Component8 | 1 | Mand | | component2 : Component7 | 0-1 | Req |
|
| | PORX_MT010120CA.Underwriter |
|---|
| classCode : "UNDWRT" (RoleClass) | 1 | Mand | id : II Business name: B:Payor Identifier A unique identifier for the payor organization responsible for the coverage extension. Gives context to the coverage extension identifier and therefore mandatory. Allows the dispensing service delivery location to know where to send a claim. | 1 | Mand | | underwritingOrganization : Organization | 1 | Mand |
|
| |
|
|
|
|---|
| PORX_MT010140CA.ActRequest |
|---|
| classCode : "ACT" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Order Number This is an identifier assigned to a specific medication order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order. Allows prescriptions to be uniquely referenced. Multiple identifiers are allowed to support assigning of prescription ids by the prescriber, EHR, and potentially by pharmacies. The ID is mandatory to allow every prescription record to be uniquely identified. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | | precondition : Precondition | 0-1 | Req |
| | PORX_MT010140CA.Component6 |
|---|
| typeCode : "COMP" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | | actRequest : ActRequest | 1 | Mand |
|
| |
| |
| PORX_MT010140CA.SupplyEvent Business name: Remaining Dispenses Indicates dispenses yet to be made against the prescription Allows updating the quantity remaining to be dispensed. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | quantity : PQ.DRUG Business name: C:Remaining Quantity Indicates the remaining quantity to be dispensed. The specified remaining fill quantity may never be greater than the remaining quantity recorded in the electronic system. If not specified, the quantity remaining will be left unchanged. Used to adjust quantity asserted with the electronic version of a prescription when fills have been issued by non-electronic pharmacies. Particularly important when the electronic version is being made 'authoritative' again. | 1 | Mand | | product : Product | 0-1 | Req |
|
| |
|
|
|
|---|
| |
PORX_MT020020CA.SupplyEvent Business name: Dispense Pickup Captures information about what prescription was picked up and who received it. The root class for the message. The time of pickup is specified on the ControlAct wrapper. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: Dispense Id Identity of prescription dispense that has been picked up. Allows dispenses to be uniquely identified. This attribute is mandatory because the identity of the dispense record must be known. | 1 | Mand | | subject : Subject | 1 | Mand | | receiver : Receiver | 0-1 | Req |
|
|
|
|
|---|
PORX_MT020030CA.ActRequest Business name: Prescription Information pertaining to a prescriber's authorization for a drug to be dispensed to a patient, as well as the instruction on when and how the drug is to be administered to the patient. This is a 'core' class of the medication model and is important for understanding what drugs the patient is intended to be receiving. Also needed for e-prescribing. |
|---|
| classCode : "ACT" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Order Number This is an identifier assigned to a specific medication order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order. Allows prescriptions to be uniquely referenced. Multiple identifiers are allowed to support assigning of prescription ids by the prescriber, EHR, and potentially by pharmacies. The ID is mandatory to allow every prescription record to be uniquely identified. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand |
| |
PORX_MT020030CA.SupplyEvent Business name: Prescription Dispense Response Represents the information returned when a dispense has been accepted Allows communication of the identifiers assigned to the dispense and the prescription by the DIS. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: Dispense Identifier Identifier of a dispense event to be used by the requesting dispenser. Establishes a record of impending dispense on the prescription. Attribute is mandatory to ensure that successful request to dispense has been acknowledged by the DIS. | 1 | Mand | | inFulfillmentOf : InFulfillmentOf | 1 | Mand |
|
|
|
|
|---|
| |
| |
| PORX_MT020050CA.ServiceDeliveryLocation The location where the supply is expected to be delivered. Allows tracking what drugs are dispensed to a facility. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II Business name: C:Ship-to Facility Id Identifier of the facility where the dispensed medication was shipped. Allows tracking what drugs are dispensed to a facility. The attribute is mandatory because identification of the facility must be known. | 1 | Mand |
|
| PORX_MT020050CA.SupplyEvent Business name: Office Supply This is the detailed information about a medication being supplied for office use. Allows for tracking of medications supplied to an office. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Local Dispense ID Identifier assigned by the dispensing facility. Allows formal tracking of centrally recorded dispenses to local records for audit and related purposes. | 0-1 | Req | code : (ActCode) Business name: Dispense Type Indicates the type of dispensing event that is being performed. This is a fixed dispense type of 'Office Supply' unless using SNOMED. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : TS.FULLDATETIME Business name: A:Supply Date Represents the date medication was supplied. Must be able to post date a dispense (enter retroactively) e.g. system failure Needed for audit purposes. Because the supply date is always known, the attribute is mandatory. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : PQ.DRUG Business name: B:Supplied Quantity The amount of medication that has been dispensed. Includes unit of measure. Allows for auditing of medication dispensed to an office. This is mandatory to allow reconciliation with the amount used from the office. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | | product : Product2 | 1 | Mand | | destination : Destination2 | 1 | Mand | | fulfillment : InFulfillmentOf | 0-1 | Req | | subjectOf : Subject7 | 0-1 | Req |
|
|
|
|
|
|---|
PORX_MT020060CA.Author Business name: bc:prescribed by The person who prescribed the device. Used to create an 'inferred' prescription if an electronic prescription does not already exist in the EHR. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescription Order Date The calendar date on which the device was prescribed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or used for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription shall always be known or absent for a reason. | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Pop |
| |
| |
PORX_MT020060CA.DeviceDispense Business name: Prescription Dispense This is the detailed information about a device dispense that has been performed on behalf a patient Dispensing is an integral part of the overall prescription process. A_BillablePharmacyDispense |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number Identifier assigned by the dispensing facility. Allows formal tracking of centrally recorded dispenses to local records for audit and related purposes. | 0-1 | Req | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Prescription Masking Indicator Communicates the intent that the dispense should be masked if it is created; If the dispense is masked, this makes the complete prescription and all dispenses masked. If a dispense is masked, it implicitly masks the prescription being dispensed. (There's no point in masking a dispense if the prescription is unmasked.) Can be used to set a mask for a new dispense, if present in a new dispense request. The attribute is optional because not all systems will support masking. DispensedItem.masked | 0-1 | Opt | | subject : Subject8 | 1 | Mand | | recordTarget : RecordTarget | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf1 | 1 | Mand | | component1 : Component11 | 0-1 | Req | | component2 : Component | 1 | Mand | | subjectOf : Subject7 | 0-1 | Req |
| PORX_MT020060CA.DeviceRequest Business name: Prescription Reference Information pertaining to the prescription for which a dispense is being created Dispenses for electronically created prescriptions must reference the prescription. The Prescriber Name must be specified only when the Prescription ID is Null |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: D:Prescription Order Number The identifier of the prescription for which a dispense is beiing created. Allows prescriptions to be uniquely referenced. The ID is only 'populated' because in some cases the prescription will not yet exist electronically. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Pop | | responsibleParty : ResponsibleParty3 | 0-1 | Req | | author : Author | 0-1 | Req |
|
| |
| |
| PORX_MT020060CA.ResponsibleParty3 Business name: supervised by Identity of the provider who is taking responsibilty for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
|
PORX_MT020060CA.ServiceDeliveryLocation Business name: Dispense Ship-To Location The location where the dispensed product is expected to be delivered. Important as part of a claim for justifying shipping charges. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: I:Ship-To Address Indicates where the dispensed product was sent. Important as part of a claim for justifying shipping charges. | 1 | Mand |
| |
| | PORX_MT020060CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPharmacySupplyType) Business name: Dispense Type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Must be able to post-date a dispense (enter retroactively) e.g. system failure. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : INT.POS Business name: Dispensed Quantity The number of devices that have been dispensed. Critical in understanding the patient's profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand | | destination : Destination2 | 0-1 | Req |
|
|
|
|
|---|
PORX_MT020070CA.Agent invariant( x) { The identifier must be either the patient identifier, the prescriber identifier or the dispenser identifier. } |
|---|
| classCode : "AGNT" (RoleClass) | 1 | Mand | id : II Business name: Substituting Person Identifier Identity of the person who ultimately made the substitution decision. Provides a trace of responsibility for the substitution. | 1 | Mand |
| PORX_MT020070CA.Author Business name: bc:prescribed by The person who prescribed the medication. Used to create an 'inferred' prescription if an electronic prescription does not already exist in the EHR. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescription Order Date The date and time at which the drug was prescribed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or administered for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription shall always be known or absent for a reason. | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Pop |
|
| |
| |
| |
PORX_MT020070CA.MedicationDispense Business name: Prescription Dispense This is the detailed information about a medication dispense that has been performed on behalf a patient Dispensing is an integral part of the overall medication process. A_BillablePharmacyDispense |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Local Dispense Id Identifier assigned by the dispensing facility. Allows formal tracking of centrally recorded dispenses to local records for audit and related purposes. | 0-1 | Req | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Prescription Masking Indicator Communicates the intent that the dispense should be masked if it is created; If the dispense is masked, this makes the complete prescription and all dispenses masked. If a dispense is masked, it implicitly masks the prescription being dispensed. (There's no point in masking a dispense if the prescription is unmasked.) Can be used to set a mask for a new dispense, if present in a new dispense request. DispensedItem.masked | 0-1 | Req | | subject : Subject8 | 1 | Mand | | recordTarget : RecordTarget | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf1 | 1 | Mand | | component1 : Component13 | 0-1 | Req | | component2 : Component11 | 1-10 | Mand | | component3 : Component | 1 | Mand | | subjectOf : Subject7 | 0-1 | Req |
| |
| |
| PORX_MT020070CA.ResponsibleParty3 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
|
PORX_MT020070CA.ServiceDeliveryLocation Business name: Dispense Ship-To Location The location where the dispensed product is expected to be delivered. Important as part of a claim for justifying shipping charges. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: I:Ship-To Address Indicates where the dispensed product was sent. Important as part of a claim for justifying shipping charges. | 1 | Mand |
| |
| PORX_MT020070CA.SubstanceAdministrationRequest Business name: Prescription Reference Information pertaining to the prescription for which a dispense is being created Dispenses for electronically created prescriptions must reference the prescription. The Prescriber Name must be specified only when the Prescription Order Number is Null. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: D:Prescription Order Number The identifier of the prescription for which a dispense is being created. Allows prescriptions to be uniquely referenced. The ID is only 'populated' because in some cases the prescription will not yet exist electronically. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Pop | | code : "DRUG" (ActCode) | 1 | Mand | | responsibleParty : ResponsibleParty3 | 0-1 | Req | | author : Author | 0-1 | Req | | component : Component2 | 0-1 | Req |
|
PORX_MT020070CA.SubstitutionMade Business name: Substitution An indication of what kind of substitution was made, if any. May explain why prescribed and dispensed medications may differ. A_BillablePharmacyDispense |
|---|
| classCode : "SUBST" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActSubstanceAdminSubstitutionCode) Business name: Substitution Code A code signifying whether a different drug was dispensed from what was prescribed. Indicates that substitution was done (or not). This attribute is mandatory because it is essential to understanding the substitution. DRU.050 Claim.408-D8 A_BillablePharmacyDispense | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | reasonCode : (SubstanceAdminSubstitutionReason) Business name: Product Selection Reason Code Indicates the reason for the substitution of (or lack of substitution) from what was prescribed. Standardized reasons for substitution performed (or not performed). Useful in analysis of dispensing patterns. DispensedItem.productSelectionCode D62 ZDP.12 A_BillablePharmacyDispense | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req |
| | PORX_MT020070CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPharmacySupplyType) Business name: Dispense Type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Must be able to post-date a dispense (enter retroactively) e.g. system failure. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : PQ.DRUG Business name: Dispensed Quantity The amount of medication that has been dispensed. Includes unit of measure. Critical in understanding the patient's medication profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand | | destination : Destination2 | 0-1 | Req |
|
PORX_MT020070CA.SupplyRequest One of Total Prescribed Quantity and Total Days Supply must be supplied when id (Prescription Order Number) is not present |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | quantity : PQ.DRUG Business name: Total Prescribed Quantity The overall amount of amount medication to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Critical in understanding the patient's medication profile, both past and current. This also allows determination of the amount that remains to be dispensed against the prescription. | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Total Days Supply The number of days that the overall prescribed item is expected to last, if the patient is compliant with the dispensing and administration of the prescription. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). | 0-1 | Req |
|
|
|
|
|---|
| |
| PORX_MT030040CA.Author2 Business name: *b:prescribed by This is the provider who authorized the medication to be dispensed to the patient. To be a legal order, the person responsible for its creation must be identified. Thus the association is mandatory. Prescription.Prescriber A_BillablePharmacyDispense |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescribed Date The date and time at which the drug was prescribed/dispensed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or administered for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription will not always be known (as in the case of 'inferred prescription'). Prescription.prescribedDate Date prescription written ZDP.8 DRU.040-02 (low, qualifier=85, format=102) DRU.040-02 (low, qualifier=LO, format=102, where filter type = most recent) Claim:414-DE | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Mand |
|
PORX_MT030040CA.CombinedMedicationRequest Business name: Prescription Where the prescription is for a combination of drugs (e.g. 10mg tablets + 40mg tablets) repeatNumber cannot be populated and quantity must be expressed in mg. This is a 'core' class of the medication model and is important for understanding what drugs the patient is intended to be receiving. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Order Number The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Allows prescriptions to be uniquely referenced. The number is mandatory to allow every prescription record to be uniquely identified. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | code : CD (ActCode) Business name: Prescription Type Indicates that this is a prescription for a drug as opposed to an immunization. For SNOMED, may also contain information regarding drug and route. Needed to convey the meaning of this class and is therefore mandatory. The element allows 'CD' to provide support for SNOMED. | 1 | Mand | statusCode : (ActStatus) Business name: C:Prescription Status This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: NEW, ACTIVE, SUSPENDED, ABORTED, COMPLETED, OBSOLETE and NULLIFIED. Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state. Prescription.state (cannot distinguish between 'Filled' and 'Unfilled', must look at amounts dispensed to distniguish between those; and also cannot distinguish modified, need to look at event history). Prescription Status | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: F:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their medication data. The attribute is optional because not all systems will support masking. Prescription.masked | 0-1 | Opt | | subject : Subject5 | 1 | Mand | | directTarget : DirectTarget | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author2 | 1 | Mand | | reason : Reason | 1-5 | Pop | | precondition : Precondition | 0-1 | Req | | derivedFrom : DerivedFrom | 0-1 | Req | | component1 : Component1 | 1 | Mand | | component2 : Component6 | 1 | Mand | | fulfillment1 : InFulfillmentOf4 | 0-1 | Req | | fulfillment2 : InFulfillmentOf5 | 0-1 | Req | | fulfillment3 : InFulfillmentOf6 | 0-1 | Req | | fulfillment4 : InFulfillmentOf2 | 0-1 | Req | | subjectOf1 : Subject | 0-1 | Req | | subjectOf2 : Subject2 | 0-1 | Req | | subjectOf3 : Subject3 | 0-10 | Req | | componentOf : Component4 | 1 | Pop |
| |
| |
| PORX_MT030040CA.DetectedIssueEvent Business name: Issues Describes an issue associated with a prescription that resulted in a dispenser refusing to fill it. Allows a dispenser to assert an issue against a prescription to be displayed to subsequent dispensers as well as others reviewing the patient's medication profile. |
|---|
| classCode : "ALRT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDetectedIssueCode) Business name: Issue Type A coded value that is used to distinguish between different kinds of issues. Types of issue include: unrecognized identifiers, permission issues, drug-drug contraindications, drug-allergy alerts, duplicate therapies, suspect fraud etc. . Identifies what kind of issue was detected or is being managed. This is mandatory so as to ensure that one issue type can be distinguished from another. | 1 | Mand | text : Business name: Issue Comment A free form textual description regarding the issue of fraudulence. This may be specified in place of, or in addition to the coded issue. Enables extra or more detailed description of the alert | 0-1 | Req | | statusCode : "completed" (ActStatus) | 1 | Mand |
|
| |
| |
| |
| PORX_MT030040CA.Location2 Business name: *c:targeted to pharmacy Indicates the pharmacy to which the prescription has been directed or which has currently assumed responsibility for dispensing the prescription. Allows prescriptions to be directed on the request of the patient or by legal requirement. Also allows indication of which pharmacy is the current 'custodian' of the prescription. This should always be known or should have an explicit null flavor of 'NA' (non-assigned) or 'UNK' (paper prescription). Thus the association is 'populated'. |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | substitutionConditionCode : (x_SubstitutionConditionNoneOrUnconditional) Business name: Dispense Facility Not Assignable Indicator Indicates a 'hard' or 'soft' assignment of dispensing priviledged to the targetted facility. 'Hard' assignment (mandated facility) indicates that the prescription can be dispensed only at that facility. 'Soft' assignment (usually as a patient directive) indicates that the prescription may be dispensed at facilities other than the targeted facility. Influences whether the prescription may be transferred to a service delivery location other than the targeted dispenser. | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| PORX_MT030040CA.Reason Business name: d:prescribed because of Denotes the reason(s) for this specific prescription; it must not be interpreted as a permanent diagnosis. Helps providers evaluate the appropriateness of the dosage instructions for the medication, and may influence education or literature provided to the patient on the use of the medication. Provided at the discretion of the prescriber to enhance patient care. E.g., take 1 tab bid for migraine. Also needed for drug-disease interaction checking software to work properly. This field is marked as populated because of its high clinical importance, however 'Nulls' are allowed because the individual recording the prescription (e.g. pharmacist) may not be aware of the indication or the prescriber may choose to withhold (mask) the information due to patient sensitivity. |
|---|
| typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | priorityNumber : INT.POS Business name: Indication Priority Ordering of prescribing indications from primary indication (low number) to minor indication (higher number). Multiple indications are permitted to have the same priority if they're considered of equivalent importance. Allows providers to indicate whether indication is the primary or secondary target of the therapy. E.g., Terazosin for Benign Prostatic Hypertrophy as primary and Hypertension as secondary or vice-versa. | 0-1 | Req | | Choice: indications : Indications | 1 | Pop | | »» observationDiagnosis : ObservationDiagnosis | 0-1 | Opt | | »» observationSymptom : ObservationSymptom | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
|
| |
| |
| |
| PORX_MT030040CA.Subject5 Business name: *a:prescribed for Identity of the person for whom the prescription was created. A legal requirement, and also allows the content to be linked to the person's EHR. As a result, this association is mandatory. DispensedItem.person Prescription.person Future use request(true when participation is not present) |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | patient : Patient | 1 | Mand |
|
PORX_MT030040CA.SupplyEventFirstSummary Business name: First Dispense Information Provides summary information about the first dispense event on the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: First Dispense Pickup Date Indicates when the first dispense against the prescription was picked up. Useful in establishing start of therapy. Important information for compliance. | 0-1 | Req | quantity : PQ.DRUG Business name: First Quantity Dispense Indicates the amount of medication first dispensed on the prescription. Usually establishes trial quantities for a prescription. If the first dispense information is known, the quantity must be known and therefore is mandatory | 1 | Mand |
| PORX_MT030040CA.SupplyEventFutureSummary Business name: Remaining Dispense Information Provides summary information about what dispenses remain to be performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Fills Remaining Indicates the number of remaining dispenses estimated, assuming that each fill is equal to the quantity prescribed for a single fill, rounding up. Indicates the number of dispenses that may still occur. | 0-1 | Req | quantity : PQ.DRUG Business name: B:Remaining Total Quantity Indicates the total remaining undispensed quantity authorized against the prescription. Indicates how much can still be dispensed. | 0-1 | Req |
|
PORX_MT030040CA.SupplyEventLastSummary Business name: Last Dispense Information Provides summary information about the most recent dispense event performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: Last Dispense Pickup Date Indicates the most recent date on which a dispense on the prescription was picked up. Useful in determining when a prescription will next need to be dispensed. Also provides an indication of compliance. | 0-1 | Req | quantity : PQ.DRUG Business name: Last Quantity Dispensed. Indicates the most recent quantity of the drug that was picked up for the prescription. Useful in determining amount of medication that a patient should have on-hand. Also provides an indication of compliance. If the most recent dispense information is known, the quantity must be known and therefore is mandatory | 1 | Mand |
| PORX_MT030040CA.SupplyEventPastSummary Business name: Previous Dispense Information Summarizes the dispenses that have happened against the prescription to date. Helps in understanding the status of the prescription and evaluating compliance. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Number of Fill Made Against Rx Indicates the number of dispense events performed against the prescription to date, including trial, partial and complete fills. Useful in tracking the progress of a prescription in prescription. | 0-1 | Req | quantity : PQ.DRUG Business name: B:Total Supplied Amount Indicates the amount of the prescribed medication that has been dispensed to-date. Useful for tracking the progress of a prescription | 0-1 | Req |
|
PORX_MT030040CA.SupplyRequest Business name: Dispense Instructions Specification of how the prescribed medication is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the medication to the patient. A_BillablePharmacyDispense |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | statusCode : (ActStatus) Business name: A:Prescription Dispense Indicator This generally mirrors the status for the prescription, but in some circumstances may be changed to 'aborted' while the prescription is still active. When this occurs, it means the prescription may no longer be dispensed, though it may still be administered. Allows a prescriber to say "Finish what you have on hand, but don't get any more." Because the status should always be known, this element is mandatory. | 1 | Mand | quantity : PQ.DRUG Business name: B:Total Prescribed Quantity The overall amount of amount medication to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Sets upper limit for medication to be dispensed. Can be used to verify the intention of the prescriber with respect to the overall medication. Used for comparison when determining whether additional quantity may be dispensed in the context of a part-fill prescription. Narcotics must always be specified as a total quantity. | 0-1 | Req | | location : Location2 | 1 | Pop |
| |
PORX_MT030040CA.WorkingListEvent Business name: Drug Use Categorization of prescriptions based on the intended duration of the prescribed therapy. Useful in establishing compliance for drug renewals and refills. |
|---|
| classCode : "LIST" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActTherapyDurationWorkingListCode) Business name: D:Prescription Treatment Type Describes the categorization of the therapy envisioned by this prescription (e.g. Continuous/Chronic, Short-Term/Acute and "As-Needed). Allows categorizing prescription for presentation. May influence detection of duplicate therapy. May also be used to affect how DUR processing is completed. The field is marked as "populated" because the intended duration of the therapy should generally be known at prescribe time. However in some circumstances, it may not be known whether a therapy will be short-term or long-term. Prescription type Prescription.drugUseIndicator | 1 | Mand |
|
|
|
|
|---|
| |
PORX_MT040010CA.OtherMedication Business name: Other Medication A record of a medication the patient is believed to be taking, but for which an electronic order does not exist. 'Other medications' include any drug product deemed relevant to the patient's drug profile, but which was not specifically ordered by a prescriber in a DIS-enabled jurisdiction. Examples include over-the counter medications that were not specifically ordered, herbal remedies, and recreational drugs. Prescription drugs that the patient may be taking but were not prescribed on the EHR (e.g. institutionally administered or out-of-jurisdiction prescriptions) will also be recorded here. Necessary component of a person's overall medication profile. Allows DUR checking against a more complete drug profile. Status can only be 'ACTIVE' or 'COMPLETED' routeCode must not be used when code is SNOMED and is mandatory otherwise |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (ActCode) Business name: Other Medication Type Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information. Needed to convey the meaning of this class and is therefore mandatory. The element allows 'CD' to provide support for SNOMED. Must be 'DRUG' unless using SNOMED | 1 | Mand | statusCode : (ActStatus) Business name: C:Other Medication Status This denotes a state in the lifecycle of the other medication. Valid statuses are: 'ACTIVE' and 'COMPLETED' only. Indicates what actions are allowed to be performed against an other medication record. This is a mandatory field because every recorded 'other medication' needs to be in some state. Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record. | 1 | Mand | effectiveTime : IVL<TS.DATE> Business name: d:Drug Active Period Indicates the time-period in which the patient has been taking or is expected to be taking the medication. Either the start or end or both can be null if they are not known. Used to help determine whether the medication is currently active. Because this information won't always be available, the attribute is marked as 'populated'. ZDP.13.2.2 ZDP.13.3 ZDP.13.4 ZDP.13.5 | 1 | Pop | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Other Medication Masking Indicator Denotes access restriction place on the other medication record. Methods for accessing masked other medications will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). Provides support for additional confidentiality constraint to reflect the wishes of the patient. The attribute is optional because not all systems will support masking. | 0-1 | Opt | routeCode : (RouteOfAdministration) Business name: F:Route of Administration This is the means by which the patient is taking the other medication. Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional. Route of administration | 0-1 | Opt | | subject : Subject10 | 1 | Mand | | consumable : Consumable2 | 1 | Mand | | component : Component | 0-10 | Req | | subjectOf : Subject9 | 0-1 | Req |
| |
|
|
|
|
|---|
PORX_MT040020CA.OtherMedication Business name: Other Medication While SNOMED codes may pre-coordinate the drug code, the drug must not be modified. However route information for a drug may be updated. The medication record being updated. routeCode must not be used when code is SNOMED and is mandatory otherwise |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Other Medication Id Identifier of the Other Medication record that needs to be updated. Uniquely identifies the record to be updated and is therefore mandatory. | 1 | Mand | code : CD (ActCode) Business name: Other Medication Type Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information. Needed to convey the meaning of this class and is therefore mandatory. The element allows 'CD' to provide support for SNOMED. Must be 'DRUG' unless using SNOMED | 1 | Mand | statusCode : (ActStatus) Business name: B:Medication Status Indicates whether the medication is still considered active. Valid status can only be 'ACTIVE' or 'COMPLETED'. Indicates the new state of the medication and is therefore mandatory. Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record. | 1 | Mand | effectiveTime : IVL<TS.DATE> Business name: C:Drug Active Period The new period in which the active medication is deemed to be active. Allows the drug active period information to be changed. | 0-1 | Req | routeCode : (RouteOfAdministration) Business name: D:Route This is the means by which the patient is taking the other medication. Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional. | 0-1 | Opt | | subject : Subject10 | 1 | Mand |
| |
|
|
|
|---|
| PORX_MT050010CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: Drug Codes Indicates that the result set is to be filtered to include only those contraindications involving the specified drugs. The codes may refer to administerable medications, orderable medications or higher level drug classifications. The set of contraindication records retrieved would include all potential DDI between and amongst the drugs. Allows for the retrieval of all potential contraindications that would result from drug profile scenarios. This will most commonly be used by providers to test the viability of prescribing/dispensing medications into profile scenarios. | 1 | Mand |
| PORX_MT050010CA.ParameterList Business name: Generic Query Parameters Defines the set of parameters that may be used to filter the query response. Root class for query definition |
|---|
| drugCode : DrugCode | 2-20 | Mand |
|
|
|
|
|---|
| PORX_MT050020CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: E:Drug Code Indicates that the result set is to be filtered to include only those contraindications pertaining to the specified drug. The code may refer to an administerable medication, an orderable medication or a higher level drug classification. The contraindication records retrieve would comprise the drug-drug interactions between this specified and each of the drugs on the patient's profile, as well as drug-disease and drug-allergy contraindications that might result (based on the information on the patient's profile). Allows for the retrieval of all potential contraindications based on a specific medication being introduced onto the patient's medication profile. Contraindications can't be found without specifying the medication, therefore this attribute is mandatory. This will most commonly be used by providers to test the viability of prescribing/dispensing a medication to a patient (in view of the patient's existing medication profile). | 1 | Mand |
| |
| PORX_MT050020CA.PatientBirthDate |
|---|
value : TS.DATE Business name: D:Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT050020CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: C:Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT050020CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient drug contraindication query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
| | PORX_MT050020CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name of the patient who is the subject of the drug contraindication query. Filter the result set to include only those records pertaining to the patient with this name. Allows filtering of result set by patient name. This is a mandatory field because a patient name must match the patient Id for the query to be valid. | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060010CA.Author5 Business name: *prescribed by Indicates the prescriber of the prescription. The prescriber is a key piece of legal information which must be conveyed and is therefore mandatory. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescription Order Date The date and time at which the device was prescribed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or used for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription shall always be known or absent for a reason. | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Mand |
|
PORX_MT060010CA.Author6 Business name: *changed by Identity of the health service provider or the application responsible for the change in the prescription dispense status. In an EHR integrated health services environment, it is important that other providers are able to query who is responsible for status changes. Also used by applications for auditing and sorting. The attribute is populated because provider or application maintaining the prescription dispense must be known else an appropriate 'null' flavor must be specified. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Change Timestamp The date and time at which the change was made. Gives other providers the frame of reference in evaluating any post-change issues with the prescription dispense. Also used for sorting and audit purposes. | 0-1 | Req | | Choice: changedBy : ChangedBy | 1 | Pop | | »» assignedPerson : AssignedPerson | 0-1 | Opt | | »» assignedDevice : AssignedDevice | 0-1 | Opt |
| |
| |
PORX_MT060010CA.ControlActEvent Business name: Dispense Status Changes This records the history of changes that have been made to the prescription dispense, including why the changes were made, who made them and when. Provides an audit trail of a patient's therapy adjustments. Status changes may affect evaluations of compliance. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (HL7TriggerEventCode) Business name: Dispense Status Change Type Identifies what kind of change occurred. Examples include Suspended, Aborted, etc. This attribute is mandatory to ensure that change types are distinguishable. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Status Change Effective Date The date on which the various status changes of a prescription dispense become valid and applicable. In the case of a suspend, may also indicate the scheduled time at which the status change will end. Allows applications to sort and filter by time. The effective date can be defaulted to change date, and thus is mandatory. | 1 | Mand | reasonCode : (ControlActReason) Business name: Dispense Status Change Reason Denotes the reason the status of the prescription dispense was changed. Ensures consistent terminology in capturing and interpreting reasons for change. Allows CWE because not all reasons will correspond to a pre-defined code. | 0-1 | Req | | responsibleParty : ResponsibleParty2 | 0-1 | Req | | author : Author6 | 1 | Pop |
| |
| PORX_MT060010CA.DeviceDispense Business name: Dispense Describes the issuing of a drug in response to an authorizing prescription. This is a 'core' class of the medication model and is important for understanding what drugs the patient is actually receiving. Annotation is only permitted if Annotation Indicator is not present Reported Issue is only permitted if Issue Indicator is not present One of DetectedIssueIndicator or Reported Issues detailed info must be returned, but not both One of AnnotationIndicator or Annotation detail info must be returned, but not both. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number The Prescription Dispense Number is a globally unique number assigned to a prescription dispense by the EHR/DIS irrespective of the source of the supply event It is created by the EHR/DIS once the dispense has passed all edits and validation. Allows dispense events to be uniquely referenced and is therefore mandatory. | 1 | Mand | statusCode : (ActStatus) Business name: B:Dispense Status Indicates whether the dispense has been picked up ('complete') or has just been processed ('active'). Indicates how far along the process the dispense event is. It should always be known and is therefore mandatory. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Prescription Masking Indicator Indicates whether the dispense (and associated prescription) is masked. Allows a patient to control access to 'sensitive' prescriptions. The attribute is optional because not all systems will support masking. | 0-1 | Opt | | responsibleParty : ResponsibleParty | 0-1 | Req | | performer : Performer3 | 1 | Mand | | location : Location | 1 | Mand | | component1 : Component11 | 0-1 | Req | | component2 : Component | 1 | Mand | | fulfillment : InFulfillmentOf | 0-1 | Req | | subjectOf1 : Subject | 0-20 | Req | | subjectOf2 : Subject6 | 0-25 | Req | | subjectOf3 : Subject12 | 0-1 | Req | | subjectOf4 : Subject13 | 0-1 | Req | | subjectOf5 : Subject7 | 0-99 | Req |
|
| |
| |
| |
| PORX_MT060010CA.ResponsibleParty2 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
|
PORX_MT060010CA.ResponsibleParty3 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| PORX_MT060010CA.ServiceDeliveryLocation Business name: Dispense Ship-To Location The location where the dispensed product is expected to be delivered. Important as part of a claim for justifying shipping charges. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: Ship To Address Indicates where the dispensed product was sent. Important as part of a claim for justifying shipping charges. | 1 | Mand |
|
| |
| |
| | PORX_MT060010CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPharmacySupplyType) Business name: Dispense Type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : INT.POS Business name: Dispensed Quantity The number of devices that have been dispensed. Critical in understanding the patient's profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Cannot be mandatory as there are some situations where 'as needed' cannot be used to determine days supply. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand | | receiver : Receiver2 | 0-1 | Req | | destination : Destination2 | 0-1 | Req |
|
PORX_MT060010CA.SupplyRequest Business name: Prescription Reference A reference to the prescription order being dispensed Links a dispense with its parent prescription. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: Prescription Order Number This is an identifier assigned to a specific device order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order. Allows prescriptions to be uniquely referenced and associated with the dispense. The ID is mandatory because the DIS will always assign a Prescription Order Number. | 1 | Mand | | responsibleParty : ResponsibleParty3 | 0-1 | Req | | author : Author5 | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060020CA.Author2 Business name: *b:prescribed by This is the provider who authorized the device to be dispensed to the patient. To be a legal order, the person responsible for its creation must be identified. Thus the association is mandatory. Prescription.Prescriber A_BillablePharmacyDispense |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescription Order Date The date and time at which the device was prescribed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or used for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated as it will not be there for inferred prescriptions. Prescription.prescribedDate Date prescription written ZDP.8 DRU.040-02 (low, qualifier=85, format=102) DRU.040-02 (low, qualifier=LO, format=102, where filter type = most recent) Claim:414-DE | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Mand |
|
| |
PORX_MT060020CA.DeviceDispense Business name: Dispense Represents the dispensing of a device to a patient. Communicates an overview of a patient's dispenses. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number The Prescription Dispense Number is a globally unique number assigned to a dispense (single fill) by the EHR/DIS irrespective of the source of the dispense. It is created by the EHR/DIS once the dispense has passed all edits and validation. Allows for the referencing of a specific dispense record. Identifier for a dispensed record is needed so that dispenses may be uniquely referenced. Thus the mandatory requirement. | 1 | Mand | statusCode : (ActStatus) Business name: C:Dispense Status Indicates the status of the dispense record created on the EHR/DIS. If 'Active' it means that the dispense has been processed but not yet given to the patient. If 'Complete', it indicates that the medication has been delivered to the patient. Important in understanding what medication the patient actually has on hand, thus the attribute is mandatory. May also influence the ability of a different pharmacy to dispense the medication. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their medication data. The attribute is optional because not all systems will support masking. | 0-1 | Opt | | responsibleParty : ResponsibleParty | 0-1 | Req | | performer : Performer | 1 | Mand | | location : Location | 1 | Mand | | component : Component2 | 1 | Mand | | fulfillment : InFulfillmentOf | 0-1 | Req | | subjectOf1 : Subject4 | 0-1 | Req | | subjectOf2 : Subject3 | 0-1 | Req |
| |
| |
| |
PORX_MT060020CA.ResponsibleParty2 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| |
| PORX_MT060020CA.Subject4 |
|---|
| typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | | contextControlCode : "ON" (ContextControl) | 1 | Mand | | contextConductionInd : "false" | 1 | Mand | | subsetCode : "SUM" (ActRelationshipSubset) | 1 | Mand | | detectedIssueIndicator : DetectedIssueIndicator | 1 | Pop |
| | PORX_MT060020CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : INT.POS Business name: Dispensed Quantity The number of devices that have been dispensed. Critical in understanding the patient's profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Cannot be mandatory as there are some situations where 'as needed' cannot be used to determine days supply. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand |
|
PORX_MT060020CA.SupplyRequest Business name: Prescription Reference A reference to the prescription order being dispensed Links a dispense with its parent prescription. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Identifier This is an identifier assigned to a specific device order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order. Allows prescriptions to be uniquely referenced and associated with the dispense. The ID is mandatory because the DIS would always assign a Prescription Number. | 1 | Mand | | responsibleParty : ResponsibleParty2 | 0-1 | Req | | author : Author2 | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060030CA.IssueFilterCode |
|---|
value : (IssueFilterCode) Business name: Issue Filter Code Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues. By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory. | 1 | Mand |
| | PORX_MT060030CA.MostRecentByDeviceIndicator |
|---|
value : Business name: Most Recent By Device Indicator Indicates whether or not the records are to be retrieved based on the most recent by Device Code. If true, only the most recent prescription or dispense or for the specified device type will be returned. The default is 'FALSE' indicating that retrieval of prescription and dispense records should not be limited to one per device type. Helps decrease the volume of records returned, while still maintaining information on all devices that the patient is using. The element is mandatory because the query recipient must know whether the value is true or false. | 1 | Mand |
|
| PORX_MT060030CA.MostRecentDispenseForEachRxIndicator |
|---|
value : Business name: Most Recent Dispense for each Rx Indicator Indicates whether or not prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription order. Allows for the returning of at most one prescription dispense record per a prescription. The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result. Helps to trim down volume of query response by eliminating multiple prescription dispenses for the same prescription order. The element is mandatory because the query recipient must know whether the value is true or false. | 1 | Mand |
| |
| PORX_MT060030CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060030CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060030CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
| | PORX_MT060030CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name of the patient who is the subject of the query. Filter the result set to include only those records pertaining to the patient with this name. Allows filtering of result set by patient name. This is a mandatory field because a patient name must match the patient Id for the query to be valid. | 1 | Mand |
|
| PORX_MT060030CA.RxDispenseIndicator |
|---|
value : (PrescriptionDispenseFilterCode) Business name: Rx Dispenser Indicators A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. The only allowable dispense indicators are: CD (Completely Dispensed) and DRR (Dispensed with Remaining Refills). The repetition of 2 allows for retrieval based on both dispense indicators. A coded value indicating the dispensing (fill) status of the prescription to be included in Allows for finer sub-set of prescriptions to be retrieved based on the fill status of the prescription. | 1 | Mand |
| | PORX_MT060030CA.UsageEffectivePeriod |
|---|
value : IVL<TS.FULLDATE> Business name: D:Usage Effective Period Indicates the usage period for which the request/query applies. Filter the result set to include only those records (prescription order and prescription dispense) for which the patient was deemed to be using the device within the specified period. Allows the requester to specify the usage period of interest for the retrieval. Useful to avoid run-away queries. | 1 | Mand |
|
|
|
|
|---|
| |
PORX_MT060040CA.Author1 Business name: *changed by Identity of the health service provider or application responsible for the change in the prescription status. In an EHR integrated health services environment, it is important that other providers are able to query who (or what application) is responsible for status changes. Also used by applications for auditing and sorting. The attribute is mandatory because provider or application maintaining the prescription must be known. PrescriptionStatus.provider |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Change Timestamp The date on which the change was made. Gives other providers the frame of reference in evaluating any post-change issues with the prescription. Also used for sorting and audit purposes. This attribute is marked as "mandatory" as the time the comment was posted will always be known. PrescriptionStatus.effectiveDate | 1 | Mand | | Choice: changedBy : ChangedBy | 1 | Mand | | »» assignedPerson : AssignedPerson | 0-1 | Opt | | »» assignedDevice : AssignedDevice | 0-1 | Opt |
| |
PORX_MT060040CA.Author4 Business name: *b:prescribed by This is the provider who authorized the device to be dispensed to the patient. To be a legal order, the person responsible for its creation must be identified. Thus the association is mandatory. Prescription.Prescriber A_BillablePharmacyDispense |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescribed Date The date and time at which the device was prescribed/dispensed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or used for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription will always be known, except for inferred prescriptions. Prescription.prescribedDate Date prescription written ZDP.8 DRU.040-02 (low, qualifier=85, format=102) DRU.040-02 (low, qualifier=LO, format=102, where filter type = most recent) Claim:414-DE | 1 | Pop | modeCode : (ParticipationMode) Business name: Prescription Transmission Method Indicates the medium in which a prescription was transmitted to or received by the person who entered it into the electronic record. Some jurisdictions have a requirement to track how an order was received. May also be important when orders are entered into a central repository from the pharmacy. ZDP.4 Claim.419-DJ | 0-1 | Req | signatureText : ED.SIGNATURE Business name: Signature An electronic signature of the prescription by the prescriber. Allows for pure electronic prescriptions without a trusted intermediary. The attribute is optional because all jurisdictions may not support digital signatures. Signature | 0-1 | Opt | | assignedPerson : AssignedPerson | 1 | Mand |
| |
| |
| |
PORX_MT060040CA.ControlActEvent Business name: Status Changes This records the history of changes that have been made to the prescription, including why the changes were made, who made them and when. Provides an audit trail of a patient's therapy adjustments. Status changes may affect evaluations of compliance. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (HL7TriggerEventCode) Business name: Change Type Identifies what kind of change occurred. Examples include Suspended, Superseded, Released, Aborted (stopped), etc. This attribute is mandatory to ensure that change types are distinguishable. Distinguishes discontinueStatus, holdStatus, reactivateStatus and releaseStatus | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Change Effective Period The date on which the various status changes of a prescription become valid and applicable. In the case of a suspend, may also indicate the scheduled time at which the status change will end. Allows applications to sort and filter by time. The effective date can be defaulted to change date, and thus is mandatory. PrescriptionStatus.initialEndDate PrescriptionStatus.actualEndDate Prescription.cancelTime Prescription.holdReleaseDate Prescription.holdStartDate Prescription.modificationTime Prescription.stopDate Prescription.reactivateDate ZPB3.14(when code is discontinued) | 1 | Mand | reasonCode : (ControlActReason) Business name: Change Reason Denotes the reason the status of the prescription was changed. Ensures consistent terminology in capturing and interpreting reasons for change. Allows CWE because not all reasons will correspond to a pre-defined code. PrescriptionStatus.reason(mnemonic) PrescriptionStatus.adhocReason(originalText) | 0-1 | Req | | responsibleParty : ResponsibleParty4 | 0-1 | Req | | author : Author1 | 1 | Mand |
| PORX_MT060040CA.Coverage Business name: Coverage Extensions An authorization issued by a payor to cover a device not previously covered by a patient's drug plan. Allows conveying special coverage information between providers. |
|---|
| classCode : "COV" (ActClass) | 1 | Mand | moodCode : (x_ActMoodOrderEvent) Business name: Extension Granted Indicator If set to 'EVN', then coverage has been granted. Otherwise it has merely been requested. Indicates to the pharmacy whether they need to check the status of coverage prior to dispensing. Mandatory due to HL7 rules. | 1 | Mand | id : II Business name: A:Coverage Extension Id Unique identification for a specific coverage extension. Allows for referencing of a specific coverage extension. This identifier may be needed on claims against the coverage. At times when the ID will not be available (such as when the request has just been submitted), the attribute is 'populated'. D64 Claim.462-EV ZDP.23.3 Authorization identifier | 1 | Pop | | author : Author2 | 1 | Mand |
|
| |
| |
PORX_MT060040CA.DetectedIssueEvent Business name: Issues Describes an issue associated with a prescription that resulted in a dispenser refusing to fill it. Allows a dispenser to assert an issue against a prescription to be displayed to subsequent dispensers as well as others reviewing the patient's medication profile. |
|---|
| classCode : "ALRT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDetectedIssueCode) Business name: A:Issue Type A coded value that is used to distinguish between different kinds of issues. Types of issue include: unrecognized identifiers, permission issues, drug-drug contraindications, drug-allergy alerts, duplicate therapies, suspect fraud etc. Identifies what kind of issue was detected or is being managed. This is mandatory so as to ensure that one issue type can be distinguished from another. | 1 | Mand | text : Business name: B:Issue Comment A free form textual description regarding the issue of fraudulence. This may be specified in place of, or in addition to the coded issue. Enables extra or more detailed description of the alert | 0-1 | Req | | statusCode : "completed" (ActStatus) | 1 | Mand |
| |
PORX_MT060040CA.DeviceDispense Business name: Prescription Dispenses This is the detailed information about a device dispense that has been performed on behalf of a patient. Dispensing is an integral part of the overall prescription process. A_BillablePharmacyDispense Reported Issue is only permitted if Issue Indicator is not present Annotation is only permitted if Annotation Indicator is not present |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number The Prescription Dispense Number is a globally unique number assigned to a dispense (single fill) by the EHR/DIS irrespective of the source of the dispense. It is created by the EHR/DIS once the dispense has passed all edits and validation. Allows for the referencing of a specific dispense record. Identifier for a dispensed record is needed so that dispenses may be uniquely referenced. Thus the mandatory requirement. DispensedItem.dispensedItemKey DispensedItem.externalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | statusCode : (ActStatus) Business name: Dispense Status Indicates the status of the dispense record created on the EHR/DIS. If 'Active' it means that the dispense has been processed but not yet given to the patient. If 'Complete', it indicates that the device has been delivered to the patient. Important in understanding what devices the patient actually has on hand, thus the attribute is mandatory. May also influence the ability of a different pharmacy to dispense the device. | 1 | Mand | | responsibleParty : ResponsibleParty3 | 0-1 | Req | | performer : Performer3 | 1 | Mand | | location : Location | 1 | Mand | | component1 : Component11 | 0-1 | Req | | component2 : Component | 1 | Mand | | subjectOf1 : Subject10 | 0-20 | Req | | subjectOf2 : Subject12 | 0-1 | Req | | subjectOf3 : Subject13 | 0-1 | Req | | subjectOf4 : Subject6 | 0-10 | Req | | subjectOf5 : Subject7 | 0-10 | Req |
| PORX_MT060040CA.DeviceRequest Business name: Prescription Information pertaining to a Prescriber's authorization for a device to be dispensed to a patient, as well as the instruction on when and how the device is to be used by the patient. This is a 'core' class of the medication model and is important for understanding what devices the patient is intended to be receiving. Reported Issue is only permitted if Issue Indicator is not present and vice versa. Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Order Number The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Allows prescriptions to be uniquely referenced. The number is mandatory to allow every prescription record to be uniquely identified. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | statusCode : (ActStatus) Business name: C:Prescription Status This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: NEW, ACTIVE, SUSPENDED, ABORTED, COMPLETED, OBSOLETE and NULLIFIED. Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state. Prescription.state (cannot distinguish between 'Filled' and 'Unfilled', must look at amounts dispensed to distniguish between those; and also cannot distinguish modified, need to look at event history). Prescription Status | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: F:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their prescription data. The attribute is optional because not all systems will support masking. Prescription.masked | 0-1 | Opt | | subject : Subject5 | 1 | Mand | | directTarget : DirectTarget | 1 | Mand | | responsibleParty : ResponsibleParty2 | 0-1 | Req | | author : Author4 | 1 | Mand | | location : Location3 | 1 | Pop | | predecessor : Predecessor | 0-1 | Req | | reason : Reason2 | 1-5 | Pop | | precondition : Precondition | 0-1 | Req | | derivedFrom : DerivedFrom | 0-1 | Req | | coverage : Coverage2 | 0-5 | Req | | component1 : Component1 | 0-1 | Req | | component2 : Component6 | 1 | Mand | | fulfillment1 : InFulfillmentOf5 | 0-1 | Req | | fulfillment2 : InFulfillmentOf4 | 0-1 | Req | | fulfillment3 : InFulfillmentOf3 | 0-1 | Req | | fulfillment4 : InFulfillmentOf2 | 0-1 | Req | | fulfillment5 : InFulfillmentOf1 | 0-999 | Req | | subjectOf1 : Subject3 | 0-25 | Req | | subjectOf2 : Subject9 | 0-20 | Req | | subjectOf3 : Subject4 | 0-99 | Req | | subjectOf4 : Subject8 | 0-10 | Req | | subjectOf5 : Subject2 | 0-1 | Req | | subjectOf6 : Subject | 0-1 | Req |
|
| |
| |
| |
| |
| PORX_MT060040CA.Location4 Business name: c:targeted to pharmacy Indicates the pharmacy to which the prescription has been directed or which has currently assumed responsibility for dispensing the prescription. Allows prescriptions to be directed on the request of the patient or by legal requirement. Also allows indication of which pharmacy is the current 'custodian' of the prescription. Prescription.facility |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : IVL.LOW<TS.FULLDATE> Business name: To be picked up when The date and time on which the dispense is expected to be picked up. Allows a prescriber to indicate to the targeted pharmacy, when patient will be expecting to pick up the dispensed device. | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
PORX_MT060040CA.PriorSupplyRequest Business name: Parent Prescription This is the original prescription that is being renewed. The current prescription uses the original prescription as the basis for its information. Helps link prescriptions together, and subsequently indications for prescribing. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: B:Previous Prescription Order Number A reference to a previous prescription which the current prescription replaces. Allows a prescription renewal (this prescription) to note the previous prescription id that was renewed; Allows tracking a therapy across multiple renewal prescriptions. New or Repeat (if present, then Repeat) | 1 | Mand |
| |
| |
PORX_MT060040CA.Reason2 Business name: d:prescribed because of Denotes the reason(s) for this specific prescription; it must not be interpreted as a permanent diagnosis. Helps providers evaluate the appropriateness of the instructions for the device, and may influence education or literature provided to the patient on the use of the device. Provided at the discretion of the prescriber to enhance patient care. E.g., take 1 tab bid for migraine. Also needed for drug-disease interaction checking software to work properly. This field is marked as populated because of its high clinical importance, however 'Nulls' are allowed because the individual recording the prescription (e.g. pharmacist) may not be aware of the indication or the prescriber may choose to withhold (mask) the information due to patient sensitivity. |
|---|
| typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | priorityNumber : INT.POS Business name: B:Indication Priority Ordering of prescribing indications from primary indication (low number) to minor indication (higher number). Multiple indications are permitted to have the same priority if they're considered of equivalent importance. Allows providers to indicate whether indication is the primary or secondary target of the therapy. E.g., Terazosin for Benign Prostatic Hypertrophy as primary and Hypertension as secondary or vice-versa. | 0-1 | Req | | Choice: indications : Indications | 1 | Pop | | »» observationDiagnosis : ObservationDiagnosis | 0-1 | Opt | | »» observationSymptom : ObservationSymptom | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
| |
| |
| PORX_MT060040CA.ResponsibleParty4 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
|
PORX_MT060040CA.ServiceDeliveryLocation Business name: Dispense Ship-To Location The location where the dispensed product is expected to be delivered. Important as part of a claim for justifying shipping charges. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: Ship To Address Indicates where the dispensed product was sent. Important as part of a claim for justifying shipping charges. | 1 | Mand |
| | PORX_MT060040CA.ServiceDeliveryLocation2 |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: H:Prescription Ship to Address Indicates the location the dispensed device should be shipped to, at the request of the patient or provider. In some cases devices need to be delivered to the patient instead of being picked up. In other cases, devices need to be shipped to the physician's office to replace stock used for the patient. | 1 | Mand |
|
| |
| |
| |
| |
PORX_MT060040CA.Subject5 Business name: *a:prescribed for Identity of the person for whom the prescription was created. A legal requirement, and also allows the content to be linked to the person's EHR. As a result, this association is mandatory. DispensedItem.person Prescription.person Future use request(true when participation is not present) |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | patient : Patient | 1 | Mand |
| |
| |
| PORX_MT060040CA.SupplyEvent Business name: Dispense Details |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPharmacySupplyType) Business name: Dispense Type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : INT.POS Business name: Dispensed Quantity The number of devices that have been dispensed. Critical in understanding the patient's profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispense Days Supply The number of days that the dispensed quantity is expected to last. Cannot be mandatory as there are some situations where 'as needed' cannot be used to determine days supply. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand | | receiver : Receiver2 | 0-1 | Req | | destination : Destination2 | 0-1 | Req |
|
PORX_MT060040CA.SupplyEventFirstSummary Business name: First Dispense Information Provides summary information about the first dispense event on the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: First Dispense Pickup Date Indicates when the first dispense against the prescription was picked up. Useful in establishing start of therapy. Important information for compliance. | 0-1 | Req | quantity : INT.NONNEG Business name: First Quantity Dispensed Indicates the amount of device first dispensed on the prescription. Usually establishes trial quantities for a prescription. If the first dispense is known, then the quantity must be known, thus the element is mandatory. | 1 | Mand |
| PORX_MT060040CA.SupplyEventFutureSummary Business name: Remaining Dispense Information Provides summary information about what dispenses remain to be performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Fills Remaining Indicates the number of remaining dispenses estimated, assuming that each fill is equal to the quantity prescribed for a single fill, rounding up. Indicates the number of dispenses that may still occur. | 0-1 | Req | quantity : INT.NONNEG Business name: B:Remaining Total Quantity Indicates the total remaining undispensed quantity authorized against the prescription. Indicates how much can still be dispensed. | 0-1 | Req |
|
PORX_MT060040CA.SupplyEventLastSummary Business name: Last Dispense Information Provides summary information about the most recent dispense event performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: Last Dispense Pickup Date Indicates the most recent date on which a dispense on the prescription was picked up. Useful in determining when a prescription will next need to be dispensed. Also provides an indication of compliance. | 0-1 | Req | quantity : INT.NONNEG Business name: Last Quantity Dispensed Indicates the most recent quantity of the drug that was picked up for the prescription. Useful in determining number of devices that a patient should have on-hand. Also provides an indication of compliance. If the last dispense is known, then the quantity must be known, thus the element is mandatory. | 1 | Mand |
| PORX_MT060040CA.SupplyEventPastSummary Business name: Previous Dispense Information Summarizes the dispenses that have happened against the prescription to date. Helps in understanding the status of the prescription and evaluating compliance. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Number of Fills Made Against Rx Indicates the number of dispense events performed against the prescription to date, including trial, partial and complete fills. Useful in tracking the progress of a prescription in prescription. | 0-1 | Req | quantity : INT.NONNEG Business name: B:Total Supplied Amount Indicates the amount of the prescribed medication that has been dispensed to-date. Useful for tracking the progress of a prescription. | 0-1 | Req |
|
PORX_MT060040CA.SupplyRequest Business name: Dispense Instructions Specification of how the prescribed device is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the device to the patient. A_BillablePharmacyDispense At least one of "Days Supply" and "Fill Quantity" must be identified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | quantity : INT.POS Business name: B:Total Prescribed Quantity The overall number of devices to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Sets upper limit for devices to be dispensed. Can be used to verify the intention of the prescriber with respect to the overall prescription. Used for comparison when determining whether additional quantity may be dispensed in the context of a part-fill prescription. | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: C:Total Days Supply The number of days that the overall prescribed item is expected to last, if the patient is compliant with the dispensing and use of the prescription. Used to specify a total authorization as a duration rather than a quantity with refills. E.g. dispense 30 at a time, refill for 1 year. May also be sent as an estimate of the expected overall duration of the prescription based on the quantity prescribed. | 0-1 | Req | | destination : Destination1 | 0-1 | Req | | location : Location4 | 0-1 | Req |
| | PORX_MT060040CA.Underwriter |
|---|
| classCode : "UNDWRT" (RoleClass) | 1 | Mand | id : II Business name: Payor Identifier A unique identifier for the payor organization responsible for the coverage extension. Gives context to the coverage extension identifier and therefore mandatory. Allows the dispensing service delivery location to know where to send a claim. | 1 | Mand | | underwritingOrganization : Organization | 1 | Mand |
|
|
|
|
|
|---|
| |
PORX_MT060060CA.Author2 Business name: *b:prescribed by This is the provider who authorized the device to be dispensed to the patient. To be a legal order, the person responsible for its creation must be identified. Thus the association is mandatory. Prescription.Prescriber A_BillablePharmacyDispense |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescribed Date The date and time at which the device was prescribed/dispensed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or used for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is mandatory because the creation datetime of the prescription will always be known. Prescription.prescribedDate Date prescription written ZDP.8 DRU.040-02 (low, qualifier=85, format=102) DRU.040-02 (low, qualifier=LO, format=102, where filter type = most recent) Claim:414-DE | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Mand |
| |
| |
| |
PORX_MT060060CA.DevicePrescription Business name: Prescription Information pertaining to a Prescriber's authorization for a device to be dispensed to a patient, as well as the instruction on when and how the device is to be used by the patient. This is a 'core' class of the medication model and is important for understanding what devices the patient is intended to be receiving. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Order Number The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Allows prescriptions to be uniquely referenced. The number is mandatory to allow every prescription record to be uniquely identified. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | statusCode : (ActStatus) Business name: C:Prescription Status This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: NEW, ACTIVE, SUSPENDED, ABORTED, COMPLETED, OBSOLETE and NULLIFIED. Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state. Prescription.state (cannot distinguish between 'Filled' and 'Unfilled', must look at amounts dispensed to distniguish between those; and also cannot distinguish modified, need to look at event history). Prescription Status | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: F:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their prescription data. The attribute is optional because not all systems will support masking. Prescription.masked | 0-1 | Opt | | subject : Subject5 | 1 | Mand | | directTarget : DirectTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Req | | author : Author2 | 1 | Mand | | reason : Reason | 1-5 | Pop | | precondition : Precondition | 0-1 | Req | | derivedFrom : DerivedFrom | 0-1 | Req | | component1 : Component1 | 0-1 | Req | | component2 : Component6 | 1 | Mand | | fulfillment1 : InFulfillmentOf4 | 0-1 | Req | | fulfillment2 : InFulfillmentOf5 | 0-1 | Req | | fulfillment3 : InFulfillmentOf6 | 0-1 | Req | | fulfillment4 : InFulfillmentOf2 | 0-1 | Req | | subjectOf1 : Subject | 0-1 | Req | | subjectOf2 : Subject2 | 0-1 | Req | | subjectOf3 : Subject3 | 0-10 | Req |
| |
| |
| |
PORX_MT060060CA.Location2 Business name: *c:targeted to pharmacy Indicates the pharmacy to which the prescription has been directed or which has currently assumed responsibility for dispensing the prescription. Allows prescriptions to be directed on the request of the patient or by legal requirement. Also allows indication of which pharmacy is the current 'custodian' of the prescription. This should always be known or should have an explicit null flavor of 'NA' (non-assigned) or 'UNK' (paper prescription). Thus the association is 'populated'. |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | substitutionConditionCode : (x_SubstitutionConditionNoneOrUnconditional) Business name: Dispense Facility Not Assignable Indicator Indicates whether a dispenser to whom the prescription is targeted is a mandated or patient-preferred pharmacy. Influences whether the prescription may be transferred to a service delivery location other than the targeted dispenser. | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| PORX_MT060060CA.Reason Business name: d:prescribed because of Denotes the reason(s) for this specific prescription; it must not be interpreted as a permanent diagnosis. Helps providers evaluate the appropriateness of the usage instructions for the device, and may influence education or literature provided to the patient on the use of the device. Provided at the discretion of the prescriber to enhance patient care. This field is marked as populated because of its high clinical importance, however 'Nulls' are allowed because the individual recording the prescription (e.g. pharmacist) may not be aware of the indication or the prescriber may choose to withhold (mask) the information due to patient sensitivity. |
|---|
| typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | priorityNumber : INT.POS Business name: Indication Priority Ordering of prescribing indications from primary indication (low number) to minor indication (higher number). Multiple indications are permitted to have the same priority if they're considered of equivalent importance. Allows providers to indicate whether indication is the primary or secondary target of the therapy. E.g., Terazosin for Benign Prostatic Hypertrophy as primary and Hypertension as secondary or vice-versa. | 0-1 | Req | | Choice: indications : Indications | 1 | Pop | | »» observationDiagnosis : ObservationDiagnosis | 0-1 | Opt | | »» observationSymptom : ObservationSymptom | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
|
| |
| |
| |
| PORX_MT060060CA.Subject5 Business name: *a:prescribed for Identity of the person for whom the prescription was created. A legal requirement, and also allows the content to be linked to the person's EHR. As a result, this association is mandatory. DispensedItem.person Prescription.person Future use request(true when participation is not present) |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | patient : Patient | 1 | Mand |
|
PORX_MT060060CA.SupplyEventFirstSummary Business name: First Dispense Information Provides summary information about the first dispense event on the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: A:First Dispense Pickup Date Indicates when the first dispense against the prescription was picked up. Useful in establishing start of therapy. Important information for compliance. | 0-1 | Req | quantity : INT.NONNEG Business name: B:First Quantity Dispensed Indicates the number of devices first dispensed on the prescription. Usually establishes trial quantities for a prescription. Because the quantity should always be known if the first dispense is known, this attribute is mandatory. | 1 | Mand |
| PORX_MT060060CA.SupplyEventFutureSummary Business name: Remaining Dispense Information Provides summary information about what dispenses remain to be performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Fills Remaining Indicates the number of remaining dispenses estimated, assuming that each fill is equal to the quantity prescribed for a single fill, rounding up. Indicates the number of dispenses that may still occur. | 0-1 | Req | quantity : INT.NONNEG Business name: B:Remaining Total Quantity Indicates the total remaining undispensed quantity authorized against the prescription. Indicates how much can still be dispensed. | 0-1 | Req |
|
PORX_MT060060CA.SupplyEventLastSummary Business name: Last Dispense Information Provides summary information about the most recent dispense event performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: A:Last Dispense Pickup Date Indicates the most recent date on which a dispense on the prescription was picked up. Useful in determining when a prescription will next need to be dispensed. Also provides an indication of compliance. | 0-1 | Req | quantity : INT.NONNEG Business name: B:Last Quantity Dispensed Indicates the most recent quantity of the drug that was picked up for the prescription. Useful in determining number of devices that a patient should have on-hand. Also provides an indication of compliance. Because the quantity should always be known if the last dispense is known, this attribute is mandatory. | 1 | Mand |
| PORX_MT060060CA.SupplyEventPastSummary Business name: Previous Dispense Information Summarizes the dispenses that have happened against the prescription to date. Helps in understanding the status of the prescription and evaluating compliance. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Number of Fills Made Against Rx Indicates the number of dispense events performed against the prescription to date, including trial, partial and complete fills. Useful in tracking the progress of a prescription in prescription. | 0-1 | Req | quantity : INT.NONNEG Business name: B:Total Supplied Amount Indicates the number of the prescribed devices that has been dispensed to-date. Useful for tracking the progress of a prescription | 0-1 | Req |
|
PORX_MT060060CA.SupplyRequest Business name: Dispense Instructions Specification of how the prescribed device is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the device to the patient. A_BillablePharmacyDispense |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | quantity : INT.POS Business name: B:Total Prescribed Quantity The overall number of devices to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Sets upper limit for devices to be dispensed. Can be used to verify the intention of the prescriber with respect to the overall prescription. Used for comparison when determining whether additional quantity may be dispensed in the context of a part-fill prescription. | 0-1 | Req | | location : Location2 | 1 | Pop |
| |
|
|
|
|---|
| PORX_MT060070CA.AmendedInTimeRange |
|---|
value : IVL<TS.FULLDATETIME> Business name: Amended in Time Range Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to 'retrieve everything that has been amended since xxx'. Allows the requester to specify the event period of interest for the retrieval of medication records. Useful for constraining run-away queries. | 1 | Mand |
| | PORX_MT060070CA.IssueFilterCode |
|---|
value : (IssueFilterCode) Business name: Issue Filter Code Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues. By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory. | 1 | Mand |
|
| PORX_MT060070CA.MostRecentByDeviceIndicator |
|---|
value : Business name: Most Recent By Device Indicator Indicates whether or not the records are to be retrieved based on the most recent by Device Code. If true, only the most recent prescription or dispense for a particular device type will be returned. The default is 'FALSE' indicating that retrieval of prescription or dispense records should not be limited to one per device type. Helps decrease the volume of records returned, while still maintaining information on all devices that the patient is using. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
| |
| PORX_MT060070CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060070CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060070CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
| | PORX_MT060070CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name by which the patient is known. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060070CA.RxDispenseIndicator |
|---|
value : (PrescriptionDispenseFilterCode) Business name: Rx Dispenser Indicators A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. Rx Dispense Indicators include: ND (Never Dispensed), DRR (Dispensed with Refills Remaining), etc. The repetition of 3 allows for retrieval based on all three Rx Dispense Indicators. Allows for finer sub-set of prescriptions to be retrieved based on the fill status of the prescription. | 1 | Mand |
| | PORX_MT060070CA.UsageEffectivePeriod |
|---|
value : IVL<TS.FULLDATE> Business name: Usage Effective Period Indicates the usage period for which the request/query applies. Filter the result set to include only those device records (device order and device dispense) for which the patient was deemed to be using the device within the specified period. Allows the requester to specify the usage period of interest for the retrieval. Useful for constraining run-away queries. | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060080CA.IssueFilterCode |
|---|
value : (IssueFilterCode) Business name: Issue Filter Code Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues. By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory. | 1 | Mand |
| |
| PORX_MT060080CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060080CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060080CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient medication query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
| | PORX_MT060080CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name of the patient who is the subject of the patient medication query. Filter the result set to include only those records pertaining to the patient with this name. Allows filtering of result set by patient name. This is a mandatory field because a patient name must match the patient Id for the query to be valid. | 1 | Mand |
|
| PORX_MT060080CA.PrescriptionOrderNumber |
|---|
value : II Business name: D:Prescription Order Number Identifier of the prescription for which detailed information is required. The result set will be filtered to only the specific prescription. Identifies the prescription that is to be retrieved and is therefore mandatory. | 1 | Mand |
|
|
|
|
|---|
PORX_MT060090CA.Agent The identifier must be either the patient identifier, the prescriber identifier or the dispenser identifier |
|---|
| classCode : "AGNT" (RoleClass) | 1 | Mand | id : II Business name: Substituting Person Identifier The identity of the person who was ultimately responsible for the drug substitution. This is either the patient, the prescriber of the dispenser. Provides a trace of responsibility for the dispensed drug. | 1 | Mand |
| |
PORX_MT060090CA.Author5 Business name: *prescribed by Indicates the prescriber of the prescription. The prescriber is a key piece of legal information which must be conveyed and is therefore mandatory. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescription Order Date The date and time at which the drug was prescribed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or administered for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription shall always be known or absent for a reason. | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Mand |
| PORX_MT060090CA.Author6 Business name: *changed by Identity of the health service provider or the application responsible for the change in the prescription dispense status. In an EHR integrated health services environment, it is important that other providers are able to query who is responsible for status changes. Also used by applications for auditing and sorting. The attribute is mandatory because provider or application maintaining the prescription dispense must be known. |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Change Timestamp The date and time at which the change was made. Gives other providers the frame of reference in evaluating any post-change issues with the prescription dispense. Also used for sorting and audit purposes. The attribute is mandatory as the time of change is known. | 1 | Mand | | Choice: changedBy : ChangedBy | 1 | Mand | | »» assignedPerson : AssignedPerson | 0-1 | Opt | | »» assignedDevice : AssignedDevice | 0-1 | Opt |
|
| |
| |
PORX_MT060090CA.ControlActEvent Business name: Dispense Status Changes This records the history of changes that have been made to the prescription dispense, including why the changes were made, who made them and when. Provides an audit trail of a patient's therapy adjustments. Status changes may affect evaluations of compliance. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (HL7TriggerEventCode) Business name: Dispense Status Change Type Identifies what kind of change occurred. Examples include Suspended, Aborted, etc. This attribute is mandatory to ensure that change types are distinguishable. | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Status Change Effective Date The date on which the various status changes of a prescription dispense become valid and applicable. In the case of a suspend, may also indicate the scheduled time at which the status change will end. Allows applications to sort and filter by time. The effective date can be defaulted to change date, and thus is mandatory. | 1 | Mand | reasonCode : (ControlActReason) Business name: Dispense Status Change Reason Denotes the reason the status of the prescription dispense was changed. Ensures consistent terminology in capturing and interpreting reasons for change. Allows CWE because not all reasons will correspond to a pre-defined code. | 0-1 | Req | | responsibleParty : ResponsibleParty4 | 0-1 | Req | | author : Author6 | 1 | Mand |
| |
| |
| PORX_MT060090CA.MedicationDispense Business name: Dispense Describes the issuing of a drug in response to an authorizing prescription. This is a 'core' class of the medication model and is important for understanding what drugs the patient is actually receiving. Reported Issue is only permitted if Issue Indicator is not present Annotation is only permitted if Annotation Indicator is not present |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number The Prescription Dispense Number is a globally unique number assigned to a dispense (single fill) by the EHR/DIS irrespective of the source of the dispense. It is created by the EHR/DIS once the dispense has passed all edits and validation. Allows for the referencing of a specific dispense record. Identifier for a dispensed record is needed so that dispenses may be uniquely referenced. Thus the mandatory requirement. | 1 | Mand | statusCode : (ActStatus) Business name: C:Dispense Status Indicates the status of the dispense record created on the EHR/DIS. If 'Active' it means that the dispense has been processed but not yet given to the patient. If 'Complete', it indicates that the medication has been delivered to the patient. Important in understanding what medication the patient actually has on hand, thus the attribute is mandatory. May also influence the ability of a different pharmacy to dispense the medication. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Prescription Masking Indicator | 0-1 | Opt | | responsibleParty : ResponsibleParty2 | 0-1 | Req | | performer : Performer3 | 1 | Mand | | location : Location | 1 | Mand | | inFulfillmentOf : InFulfillmentOf | 0-1 | Req | | component1 : Component11 | 1-10 | Mand | | component2 : Component13 | 0-1 | Req | | component3 : Component | 1 | Mand | | subjectOf1 : Subject | 0-20 | Req | | subjectOf2 : Subject6 | 0-25 | Req | | subjectOf3 : Subject7 | 0-99 | Req | | subjectOf4 : Subject13 | 0-1 | Req | | subjectOf5 : Subject12 | 0-1 | Req |
|
| |
| |
| PORX_MT060090CA.ResponsibleParty3 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
|
PORX_MT060090CA.ResponsibleParty4 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| PORX_MT060090CA.ServiceDeliveryLocation Business name: Dispense Ship-To Location The location where the dispensed product is expected to be delivered. Important as part of a claim for justifying shipping charges. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: Ship To Address Indicates where the dispensed product was sent. Important as part of a claim for justifying shipping charges. | 1 | Mand |
|
| |
| |
| PORX_MT060090CA.SubstanceAdministrationRequest Business name: Prescription Reference A reference to the prescription order being dispensed Links a dispense with its parent prescription. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: Prescription Order Number This is an identifier assigned to a specific medication order. The number remains constant across the lifetime of the order, regardless of the number of providers or pharmacies involved in fulfilling the order. Allows prescriptions to be uniquely referenced and associated with the dispense. The ID is mandatory because the DIS will always assign a Prescription Order Number. | 1 | Mand | | code : "DRUG" (ActCode) | 1 | Mand | | responsibleParty : ResponsibleParty3 | 0-1 | Req | | author : Author5 | 1 | Mand |
|
PORX_MT060090CA.SubstitutionMade Business name: Substitution An indication of what kind of substitution made, if any. May explain why prescribed and dispensed medications differ. A_BillablePharmacyDispense |
|---|
| classCode : "SUBST" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActSubstanceAdminSubstitutionCode) Business name: Substitution Code A code signifying whether a different drug was dispensed from what was prescribed. Indicates that substitution was done (or not). This attribute is mandatory because it is essential to understanding the substitution. DRU.050 Claim.408-D8 A_BillablePharmacyDispense | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | reasonCode : (SubstanceAdminSubstitutionReason) Business name: Product Selection Reason Code Indicates the reason for the substitution of (or failure to substitute) the medication from what was prescribed. Standardized reasons for substitution performed (or not performed). Useful in analysis of dispensing patterns. DispensedItem.productSelectionCode D62 ZDP.12 A_BillablePharmacyDispense | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req |
| | PORX_MT060090CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPharmacySupplyType) Business name: Dispense Type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : PQ.DRUG Business name: Dispensed Quantity The amount of medication that has been dispensed. Includes unit of measure. Critical in understanding the patient's medication profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Cannot be mandatory as there are some situations where 'as needed' cannot be used to determine days supply. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand | | receiver : Receiver2 | 0-1 | Req | | destination : Destination2 | 0-1 | Req |
|
|
|
|
|---|
| |
PORX_MT060100CA.Author2 Business name: *b:prescribed by This is the provider who authorized the medication to be dispensed to the patient. To be a legal order, the person responsible for its creation must be identified. Thus the association is mandatory. Prescription.Prescriber A_BillablePharmacyDispense |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescription Order Date The date and time at which the drug was prescribed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or administered for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated as it will not be there for inferred prescriptions. Prescription.prescribedDate Date prescription written ZDP.8 DRU.040-02 (low, qualifier=85, format=102) DRU.040-02 (low, qualifier=LO, format=102, where filter type = most recent) Claim:414-DE | 1 | Pop | | assignedPerson : AssignedPerson | 1 | Mand |
| |
| |
| |
PORX_MT060100CA.MedicationDispense Business name: Dispense Describes the issuing of a drug in response to an authorizing prescription. This is a 'core' class of the medication model and is important for understanding what drugs the patient is actually receiving. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number The Prescription Dispense Number is a globally unique number assigned to a prescription dispense by the EHR/DIS irrespective of the source of the supply event It is created by the EHR/DIS once the dispense has passed all edits and validation. Allows dispense events to be uniquely referenced and is therefore mandatory. | 1 | Mand | statusCode : (ActStatus) Business name: C:Dispense Status Indicates whether the dispense has been picked up ('complete') or has just been processed ('active'). Indicates how far along the process the dispense event is. It should always be known and is therefore mandatory. | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: E:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their medication data. The attribute is optional because not all systems will support masking. | 0-1 | Opt | | responsibleParty : ResponsibleParty | 0-1 | Req | | performer : Performer | 1 | Mand | | location : Location | 1 | Mand | | component1 : Component2 | 1 | Mand | | component2 : Component11 | 1 | Mand | | fulfillment : InFulfillmentOf | 0-1 | Req | | subjectOf1 : Subject4 | 0-1 | Req | | subjectOf2 : Subject3 | 0-1 | Req |
| |
| |
PORX_MT060100CA.ResponsibleParty2 Business name: *e:supervised by Identification of the provider who was supervising the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| |
| PORX_MT060100CA.SubstanceAdministrationRequest Business name: Prescription Indicates the order being dispensed Provides a drill-down link from the prescription to its corresponding order. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Identifier The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Links the dispense to the prescription it fulfilled. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | | code : "DRUG" (ActCode) | 1 | Mand | | responsibleParty : ResponsibleParty2 | 0-1 | Req | | author : Author2 | 1 | Mand |
|
| PORX_MT060100CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Dispense Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : PQ.DRUG Business name: Dispensed Quantity The amount of medication that has been dispensed. Includes unit of measure. Critical in understanding the patient's medication profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Cannot be mandatory as there are some situations where 'as needed' cannot be used to determine days supply. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Because 'Days Supply' may be necessary to compute total dispensed quantity, it is made a 'populated' field. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060110CA.AdministrationEffectivePeriod |
|---|
value : IVL<TS.FULLDATE> Business name: D:Administration Effective Period Indicates the administration period for which the request/query applies. Filter the result set to include only those medication records (prescription order, prescription dispense and other active medication) for which the patient was deemed to be taking the drug within the specified period. Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries. | 1 | Mand |
| | PORX_MT060110CA.IssueFilterCode |
|---|
value : (IssueFilterCode) Business name: Issue Filter Code Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues. By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory. | 1 | Mand |
|
| PORX_MT060110CA.MostRecentByDrugIndicator |
|---|
value : Business name: Most Recent By Drug Indicator Indicates whether or not the medication records are to be retrieved based on the most recent by Drug Code. If true, only the most recent prescription, dispense or other active medication for a particular drug generic classification will be returned. The default is 'FALSE' indicating that retrieval of prescription, dispense and other active medication records should not be limited to one per drug. Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
| | PORX_MT060110CA.MostRecentDispenseForEachRxIndicator |
|---|
value : Business name: Most Recent Dispense for each Rx Indicator Indicates whether or not prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription order. Allows for the returning of at most one prescription dispense record per a prescription. The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result. Helps to trim down volume of query response by eliminating multiple prescription dispenses for the same prescription order. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
|
| | PORX_MT060110CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060110CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060110CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient medication query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
|
| PORX_MT060110CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name of the patient who is the subject of the patient medication query. Filter the result set to include only those records pertaining to the patient with this name. Allows filtering of result set by patient name. This is a mandatory field because a patient name must match the patient Id for the query to be valid. | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060130CA.AdministrationEffectivePeriod |
|---|
value : IVL<TS.FULLDATE> Business name: Administration Effective Period Indicates the period for which the request/query applies. Filter the result set to include only those items that are 'effective' in the indicated period. Allows the requester to specify the period of interest for the retrieval. Useful for constraining run-away queries. | 1 | Mand |
| | PORX_MT060130CA.AmendedInTimeRange |
|---|
value : IVL<TS.FULLDATETIME> Business name: Amended in Time Range Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to 'retrieve everything that has been amended since xxx'. Allows the requester to specify the event period of interest for the retrieval of medication records. Useful for constraining run-away queries. | 1 | Mand |
|
| PORX_MT060130CA.IssueFilterCode |
|---|
value : (IssueFilterCode) Business name: Issue Filter Code Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues. By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory. | 1 | Mand |
| | PORX_MT060130CA.MostRecentByDrugIndicator |
|---|
value : Business name: Most Recent By Drug Indicator Indicates whether or not the medication records are to be retrieved based on the most recent by Drug Code. If true, only the most recent prescription, dispense or other active medication for a particular drug generic classification will be returned. The default is 'FALSE' indicating that retrieval of prescription, dispense and other active medication records should not be limited to one per drug. Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
|
| | PORX_MT060130CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060130CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060130CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient medication query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
|
| PORX_MT060130CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name by which the patient is known. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060130CA.RxDispenseIndicator |
|---|
value : (PrescriptionDispenseFilterCode) Business name: Rx Dispenser Indicators A coded value indicating the dispensing (fill) status of the prescription to be included in the result set. Rx Dispense Indicators include: ND (Never Dispensed), DRR (Dispensed with Refills Remaining), etc. The repetition of 3 allows for retrieval based on all three Rx Dispense Indicators. Allows for finer sub-set of prescriptions to be retrieved based on the fill status of the prescription. | 1 | Mand |
|
|
|
|
|---|
PORX_MT060160CA.Agent The identifier must be either the patient identifier, the prescriber identifier or the dispenser identifier |
|---|
| classCode : "AGNT" (RoleClass) | 1 | Mand | id : II Business name: Substituting Person Identifier The identity of the person who was ultimately responsible for the drug substitution. This is either the patient, the prescriber of the dispenser. Provides a trace of responsibility for the dispensed drug. | 1 | Mand |
| |
| PORX_MT060160CA.Author1 Business name: *changed by Identity of the health service provider or application responsible for the change in the prescription status. In an EHR integrated health services environment, it is important that other providers are able to query who (or what application) is responsible for status changes. Also used by applications for auditing and sorting. The attribute is "mandatory" because provider or application maintaining the prescription must be known. PrescriptionStatus.provider |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME Business name: Change Timestamp The date and time at which the change was made. Gives other providers the frame of reference in evaluating any post-change issues with the prescription. Also used for sorting and audit purposes. The attribute is marked as "mandatory" because the time of change must be known. PrescriptionStatus.effectiveDate | 1 | Mand | | Choice: changedBy : ChangedBy | 1 | Mand | | »» assignedPerson : AssignedPerson | 0-1 | Opt | | »» assignedDevice : AssignedDevice | 0-1 | Opt |
|
| PORX_MT060160CA.Author4 Business name: *b:prescribed by This is the provider who authorized the medication to be dispensed to the patient. To be a legal order, the person responsible for its creation must be identified. Thus the association is mandatory. Prescription.Prescriber A_BillablePharmacyDispense |
|---|
| typeCode : "AUT" (ParticipationType) | 1 | Mand | | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME Business name: Prescribed Date The date and time at which the drug was prescribed/dispensed. This may differ from the date on which the prescription becomes effective. E.g. A prescription created today may not be valid to be dispensed or administered for two weeks. Indicates when the action was performed, and may influence expiry dates for the order. The attribute is populated because the creation datetime of the prescription may not be known, as in the case of 'inferred prescription'. Prescription.prescribedDate Date prescription written ZDP.8 DRU.040-02 (low, qualifier=85, format=102) DRU.040-02 (low, qualifier=LO, format=102, where filter type = most recent) Claim:414-DE | 1 | Pop | modeCode : (ParticipationMode) Business name: Prescription Transmission Method Indicates the medium in which a prescription was transmitted to or received by the person who entered it into the electronic record. Some jurisdictions have a requirement to track how an order was received. May also be important when orders are entered into a central repository from the pharmacy. ZDP.4 Claim.419-DJ | 0-1 | Req | signatureText : ED.SIGNATURE Business name: Signature An electronic signature of the prescription by the prescriber. Allows for pure electronic prescriptions without a trusted intermediary. The attribute is optional because all jurisdictions may not support digital signatures. Signature | 0-1 | Opt | | assignedPerson : AssignedPerson | 1 | Mand |
|
| |
| PORX_MT060160CA.CarrierRole |
|---|
| classCode : "UNDWRT" (RoleClass) | 1 | Mand | id : II Business name: Payor Identifier A unique identifier for the payor organization responsible for the coverage extension. Gives context to the coverage extension identifier and therefore mandatory. Allows the dispensing service delivery location to know where to send a claim. | 1 | Mand | | underwritingCarrierOrganization : CarrierOrganization | 1 | Mand |
| |
PORX_MT060160CA.CombinedMedicationRequest Business name: Prescription Information pertaining to a Prescriber's authorization for a drug to be dispensed to a patient, as well as the instruction on when and how the drug is to be administered to the patient. This is a 'core' class of the medication model and is important for understanding what drugs the patient is intended to be receiving. Reported Issue is only permitted if Issue Indicator is not present and vice versa Annotation is only permitted if Detected Issue Indicator is not present and vice versa |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Order Number The Prescription Order Number is a globally unique number assigned to a prescription by the EHR/DIS irrespective of the source of the order It is created by the EHR/DIS once the prescription has passed all edits and validation. Allows prescriptions to be uniquely referenced. The number is mandatory to allow every prescription record to be uniquely identified. Prescription.prescriptionNumber Prescription.prescriptionExternalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 X0101(id for prescription) ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | code : CD (ActCode) Business name: Prescription Type Indicates that this is a prescription for a drug as opposed to an immunization. For SNOMED, may also contain information regarding drug and route. Needed to convey the meaning of this class and is therefore mandatory. The element allows 'CD' to provide support for SNOMED. | 1 | Mand | statusCode : (ActStatus) Business name: C:Prescription Status This denotes the state of the prescription in the lifecycle of the prescription. Valid statuses are: NEW, ACTIVE, SUSPENDED, ABORTED, COMPLETED, OBSOLETE and NULLIFIED. Indicates what actions are allowed to be performed against a prescription. This is a mandatory field because every prescription needs to be in some state. Prescription.state (cannot distinguish between 'Filled' and 'Unfilled', must look at amounts dispensed to distniguish between those; and also cannot distinguish modified, need to look at event history). Prescription Status | 1 | Mand | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: F:Prescription Masking Indicator Communicates the intent of the patient to restrict access to their prescriptions. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Valid values are: 'NORMAL' (denotes 'Not Masked'); and 'RESTRICTED' (denotes 'Masked'). The default is 'NORMAL' signifying 'Not Masked'. Allows the patient to have discrete control over access to their medication data. The attribute is optional because not all systems will support masking. Prescription.masked | 0-1 | Opt | | subject : Subject5 | 1 | Mand | | directTarget : DirectTarget | 0-1 | Req | | responsibleParty : ResponsibleParty2 | 0-1 | Req | | author : Author4 | 1 | Mand | | location : Location3 | 1 | Pop | | definition : Definition | 0-5 | Req | | predecessor : Predecessor | 0-1 | Req | | reason : Reason2 | 1-5 | Pop | | precondition : Precondition | 0-1 | Req | | derivedFrom : DerivedFrom | 0-1 | Req | | coverage : Coverage2 | 0-5 | Req | | pertinentInformation : PertinentInformation | 0-6 | Req | | component1 : Component1 | 1-10 | Mand | | component2 : Component2 | 1 | Mand | | component3 : Component6 | 1 | Pop | | fulfillment1 : InFulfillmentOf1 | 0-999 | Req | | fulfillment2 : InFulfillmentOf5 | 0-1 | Req | | fulfillment3 : InFulfillmentOf4 | 0-1 | Req | | fulfillment4 : InFulfillmentOf3 | 0-1 | Req | | fulfillment5 : InFulfillmentOf2 | 0-1 | Req | | subjectOf1 : Subject18 | 0-25 | Req | | subjectOf2 : Subject2 | 0-1 | Req | | subjectOf3 : Subject4 | 0-99 | Req | | subjectOf4 : Subject3 | 0-1 | Req | | subjectOf5 : Subject8 | 0-1 | Req | | subjectOf6 : Subject22 | 0-20 | Req | | subjectOf7 : Subject16 | 0-10 | Req | | componentOf : Component4 | 1 | Pop |
| |
| |
| |
| |
| |
| |
| PORX_MT060160CA.ControlActEvent Business name: Status Changes This records the history of changes that have been made to the prescription, including why the changes were made, who made them and when. Provides an audit trail of a patient's therapy adjustments. Status changes may affect evaluations of compliance. |
|---|
| classCode : "CACT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (HL7TriggerEventCode) Business name: Change Type Identifies what kind of change occurred. Examples include Suspended, Superseded, Released, Aborted (stopped), etc. This attribute is mandatory to ensure that change types are distinguishable. Distinguishes discontinueStatus, holdStatus, reactivateStatus and releaseStatus | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: Change Effective Period The date on which the various status changes of a prescription become valid and applicable. In the case of a suspend, may also indicate the scheduled time at which the status change will end. Allows applications to sort and filter by time. The effective date can be defaulted to change date, and thus is mandatory. PrescriptionStatus.initialEndDate PrescriptionStatus.actualEndDate Prescription.cancelTime Prescription.holdReleaseDate Prescription.holdStartDate Prescription.modificationTime Prescription.stopDate Prescription.reactivateDate ZPB3.14(when code is discontinued) | 1 | Mand | reasonCode : (ControlActReason) Business name: Change Reason Denotes the reason the status of the prescription was changed. Ensures consistent terminology in capturing and interpreting reasons for change. Allows CWE because not all reasons will correspond to a pre-defined code. PrescriptionStatus.reason(mnemonic) PrescriptionStatus.adhocReason(originalText) | 0-1 | Req | | responsibleParty : ResponsibleParty6 | 0-1 | Req | | author : Author1 | 1 | Mand |
|
PORX_MT060160CA.Coverage Business name: Coverage Extensions An authorization issued by a payor to cover a drug not previously covered by a patient's drug plan. Allows conveying special coverage information between providers. |
|---|
| classCode : "COV" (ActClass) | 1 | Mand | moodCode : (x_ActMoodOrderEvent) Business name: Extension Granted Indicator If set to 'EVN', then coverage has been requested. Otherwise it has merely been requested. Indicates to the pharmacy whether they need to check the status of coverage prior to dispensing. Mandatory due to HL7 rules. | 1 | Mand | id : II Business name: A:Coverage Extension Id Unique identification for a specific coverage extension. Allows for referencing of a specific coverage extension. This identifier may be needed on claims against the coverage. At times when the ID will not be available (such as when the request has just been submitted), the attribute is 'populated'. | 1 | Pop | | author : Author2 | 1 | Mand |
| |
| |
| |
PORX_MT060160CA.DetectedIssueEvent Business name: Issues Describes an issue associated with a prescription that resulted in a dispenser refusing to fill it. Allows a dispenser to assert an issue against a prescription to be displayed to subsequent dispensers as well as others reviewing the patient's medication profile. |
|---|
| classCode : "ALRT" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDetectedIssueCode) Business name: Issue Type A coded value that is used to distinguish between different kinds of issues. Types of issue include: unrecognized identifiers, permission issues, drug-drug contraindications, drug-allergy alerts, duplicate therapies, suspect fraud etc. Identifies what kind of issue was detected or is being managed. This is mandatory so as to ensure that one issue type can be distinguished from another. | 1 | Mand | text : Business name: Issue Comment A free form textual description regarding the issue of fraudulence. This may be specified in place of, or in addition to the coded issue. Enables extra or more detailed description of the alert | 0-1 | Req | | statusCode : "completed" (ActStatus) | 1 | Mand |
| |
PORX_MT060160CA.DirectTarget Business name: *c:prescribes Indicates the medication that has been prescribed (or inferred from a dispense) to the patient. This is a key aspect of the prescription. Because drug is sometimes pre-coordinated into code by SNOMED, this associaiton is only 'required'. Association is mandatory when not using SNOMED |
|---|
| typeCode : "DIR" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | medication : Medication | 1 | Pop |
| |
| |
| |
PORX_MT060160CA.InitialSupplyRequest Business name: First Fill Special instructions regarding the very first supply of medication to a patient. Allows a different amount to be dispensed on an initial fill, either as a trial or to synchronize refill dates across multiple patient prescriptions |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: First Fill Expiry Date The date before which an initial dispense can be made against the prescription. If an initial fill has not been made against the prescription in this time-period, it may not be dispensed. Some jurisdictions have distinct stale-date periods for the initial fill of a prescription from the overall dispensing of the prescription. E.g. "The first fill must be made within 1 year, all fills must be complete within 1.5 years". (This attribute would be used for the "1 year".) | 0-1 | Req | quantity : PQ.DRUG Business name: First Fill Quantity The quantity of medication to be dispensed the first time the prescription is dispensed against. Allows a limited quantity to be dispensed for a trial or for a synchronizing dose. Prescription.coordinatingAmount | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: First Fill Days Supply The number of days that the first fill is expected to last, if the patient is compliant with the dispensing of the first fill and with administration of the prescription. Used when the prescriber cannot or does not wish to calculate the quantity necessary to last for the trial or synchronization time. | 0-1 | Req |
| |
| |
| PORX_MT060160CA.Location5 Business name: *c:targeted to pharmacy Indicates the pharmacy to which the prescription has been directed or which has currently assumed responsibility for dispensing the prescription. Allows prescriptions to be directed on the request of the patient or by legal requirement. Also allows indication of which pharmacy is the current 'custodian' of the prescription. This should always be known or should have an explicit null flavor of 'NA' (non-assigned) or 'UNK' (paper prescription). Thus the association is 'populated'. Prescription.facility |
|---|
| typeCode : "LOC" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : IVL.LOW<TS.FULLDATE> Business name: To be picked up when The date and time on which the dispense is expected to be picked up. Allows a prescriber to indicate to the targeted pharmacy, when patient will be expecting to pick up the dispensed medication. | 0-1 | Req | substitutionConditionCode : (x_SubstitutionConditionNoneOrUnconditional) Business name: Assigned Facility Not Reassignable Indicator Indicates whether a dispenser to whom the prescription is targeted is a mandated or patient-preferred pharmacy. Influences whether the prescription may be transferred to a service delivery location other than the targeted dispenser. | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
PORX_MT060160CA.MedicationDispense Business name: Prescription Dispenses This is the detailed information about a medication dispense that has been performed on behalf of a patient. Dispensing is an integral part of the overall medication process. A_BillablePharmacyDispense Reported Issue is only permitted if Issue Indicator is not present and vice versa Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Prescription Dispense Number The Prescription Dispense Number is a globally unique number assigned to a dispense (single fill) by the EHR/DIS irrespective of the source of the dispense. It is created by the EHR/DIS once the dispense has passed all edits and validation. Allows for the referencing of a specific dispense record. Identifier for a dispensed record is needed so that dispenses may be uniquely referenced. Thus the mandatory requirement. DispensedItem.dispensedItemKey DispensedItem.externalKey D53(ID for the prescription assigned by pharmacy) D55(ID for the dispense event) D99.01 ZDP.5 ZDP.6 ZDP.22 ZRV.5 DRU.080-01(extension) DRU.080-02(route) Claim.455-EM (route) Claim.402-D2 (extension) Claim.456-EN Claim.454-EK A_BillablePharmacyDispense | 1 | Mand | statusCode : (ActStatus) Business name: C:Dispense Status Indicates the status of the dispense record created on the EHR/DIS. If Active it means that the dispense has been processed but not yet given to the patient. If Complete, it indicates that the medication has been delivered to the patient. Important in understanding what medication the patient actually has on hand, thus the attribute is mandatory. May also influence the ability of a different pharmacy to dispense the medication. | 1 | Mand | | responsibleParty : ResponsibleParty3 | 0-1 | Req | | performer : Performer3 | 1 | Mand | | location : Location | 1 | Mand | | component1 : Component | 1 | Mand | | component2 : Component11 | 1-10 | Mand | | component3 : Component13 | 0-1 | Req | | subjectOf1 : Subject | 0-20 | Req | | subjectOf2 : Subject12 | 0-1 | Req | | subjectOf3 : Subject13 | 0-1 | Req | | subjectOf4 : Subject7 | 0-99 | Req | | subjectOf5 : Subject6 | 0-25 | Req |
| |
PORX_MT060160CA.OtherMedication Business name: Other Medications A record of a medication the patient is believed to be taking, but for which an electronic order does not exist. 'Other medications' include any drug product deemed relevant to the patient's drug profile, but which was not specifically ordered by a prescriber in a DIS-enabled jurisdiction. Examples include over-the counter medications that were not specifically ordered, herbal remedies, and recreational drugs. Prescription drugs that the patient may be taking but was not prescribed on the EHR (e.g. institutionally administered or out-of-jurisdiction prescriptions) will also be recorded here. Necessary component of a person's overall medication profile. Allows DUR checking against a more complete drug profile. routeCode must not be used when code is SNOMED and is mandatory otherwise Status can only be ACTIVE or COMPLETED Reported Issue is only permitted if Issue Indicator is not present and vice versa Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | id : II Business name: A:Administration Record Id This is an identifier assigned to a unique instance of an other medication record. Allows for the unique referencing of a specific active medication record. Thus the mandatory requirement. . | 1 | Mand | code : CD (ActCode) Business name: Other Medication Type Indicates that the record is a drug administration rather than an immunization or other type of administration. For SNOMED, may also include route, drug and other information. Needed to convey the meaning of this class and is therefore mandatory. The element allows 'CD' to provide support for SNOMED. Must be 'DRUG' unless using SNOMED | 1 | Mand | statusCode : (ActStatus) Business name: B:Other Medication Status Indicates the status of the other medication record created on the EHR/DIS. Valid statuses for other medication records are: ACTIVE, COMPLETE. Used to determine whether the medication should be considered in performing DUR checking. Attribute is mandatory to ensure that a medication recorded in EHR/DIS is in some state. Note ------ The provider might know that the patient is not taking the medication but not necessarily when the patient stopped it. Thus the status of the medication could be set to 'COMPLETED' by the provider without necessarily setting an End Date on the medication record. | 1 | Mand | effectiveTime : IVL<TS.DATE> Business name: C:Drug Active Period Indicates the time-period in which the patient has been taking or is expected to be taking the other medication. Used to indicate help determine whether the medication is currently active. Because this information won't always be available, the attribute is marked as 'populated'. ZDP.13.2.2 ZDP.13.3 ZDP.13.4 ZDP.13.5 | 1 | Pop | confidentialityCode : (x_VeryBasicConfidentialityKind) Business name: D:Other Medication Masking Indicator Denotes access restriction place on the other active medication record. Methods for accessing masked active medications will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). Provides support for additional confidentiality constraint to reflect the wishes of the patient. The attribute is optional because not all systems will support masking. | 0-1 | Opt | routeCode : (RouteOfAdministration) Business name: E:Route of Administration This is the means by which the patient is taking the medication. Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Because this information is pre-coordinated into 'code' for SNOMED, it is marked as optional. RXR.1 Route of administration | 0-1 | Opt | | subject : Subject10 | 1 | Mand | | consumable : Consumable2 | 1 | Mand | | responsibleParty : ResponsibleParty4 | 0-1 | Req | | author : Author | 1 | Mand | | location : Location2 | 1 | Mand | | component : Component5 | 0-10 | Req | | subjectOf1 : Subject11 | 0-20 | Req | | subjectOf2 : Subject9 | 0-1 | Req | | subjectOf3 : Subject14 | 0-99 | Req | | subjectOf4 : Subject15 | 0-1 | Req | | subjectOf5 : Subject17 | 0-25 | Req |
| |
| |
| PORX_MT060160CA.PriorCombinedMedicationRequest Business name: Parent Prescription This is the original prescription that is being renewed. The current prescription uses the original prescription as the basis for its information. Helps link prescriptions together, and subsequently indications for prescribing. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | id : II Business name: B:Previous Prescription Order Number A reference to a previous prescription which the current prescription replaces. Allows a prescription renewal (this prescription) to note the previous prescription id that was renewed; Allows tracking a therapy across multiple renewal prescriptions. New or Repeat (if present, then Repeat) | 1 | Mand | | code : "DRUG" (ActCode) | 1 | Mand |
|
| |
PORX_MT060160CA.QuantityObservationEvent Business name: Prescription Patient Measurements This comprises the height and/or weight of a patient as measured/observed/known by the prescriber at the time of prescribing. Allows patient height and weight to be conveyed to the pharmacy for dosage calculation or verification |
|---|
| classCode : "OBS" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (x_ActObservationHeightOrWeight) Business name: Prescription Patient Measurement Type Identification of the type of observation that was made about the patient. The only two allowable types are height and weight. Distinguishes height from weight. Code is mandatory to ensure that measurements/observations are distinguishable. OBS.010-01 Clinical.495-H2 | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : TS.FULLDATE Business name: Prescription Patient Measurement Time The date on which the measurement was made. Allows provider to evaluate currency of the information. The attribute is populated because the measurement time must be known or a null flavor must be specified. OBS.010-04 Clinical.494-ZE Clinical.495-H1 | 1 | Pop | value : PQ.HEIGHTWEIGHT Business name: Prescription Patient Measured Value The amount (quantity and unit) that has been recorded for the patient's height and/or weight. E.g. height in meters, weight in kilograms, etc. Provides comparable representation of the measurement. May be used in calculations. The attribute is mandatory because the measurement value must be known. OBS.010-02 (quantity) OBS.010-03 (unit) Clinical.595-H4 (value) Clinical.495-H3 (unit) | 1 | Mand |
| |
PORX_MT060160CA.Reason2 Business name: d:prescribed because of Denotes the reason(s) for this specific prescription; it must not be interpreted as a permanent diagnosis. Helps providers evaluate the appropriateness of the dosage instructions for the medication, and may influence education or literature provided to the patient on the use of the medication. Provided at the discretion of the prescriber to enhance patient care. E.g., take 1 tab bid for migraine. Also needed for drug-disease interaction checking software to work properly. This field is marked as populated because of its high clinical importance, however 'Nulls' are allowed because the individual recording the prescription (e.g. pharmacist) may not be aware of the indication or the prescriber may choose to withhold (mask) the information due to patient sensitivity. |
|---|
| typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | contextControlCode : "AN" (ContextControl) | 1 | Mand | | contextConductionInd : "true" | 1 | Mand | priorityNumber : INT.POS Business name: B:Indication Priority Ordering of prescribing indications from primary indication (low number) to minor indication (higher number). Multiple indications are permitted to have the same priority if they're considered of equivalent importance. Allows providers to indicate whether indication is the primary or secondary target of the therapy. E.g., Terazosin for Benign Prostatic Hypertrophy as primary and Hypertension as secondary or vice-versa. | 0-1 | Req | | Choice: indications : Indications | 1 | Pop | | »» observationDiagnosis : ObservationDiagnosis | 0-1 | Opt | | »» observationSymptom : ObservationSymptom | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
| |
| |
| |
| |
PORX_MT060160CA.ResponsibleParty6 Business name: supervised by Identity of the provider who is taking responsibility for the actions of the author. Allows for the trail of responsibility for the action. |
|---|
| typeCode : "RESP" (ParticipationType) | 1 | Mand | | assignedPerson : AssignedPerson | 1 | Pop |
| PORX_MT060160CA.ServiceDeliveryLocation Business name: Dispense Ship-To Location The location where the dispensed product is expected to be delivered. Important as part of a claim for justifying shipping charges. |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: Ship To Address Indicates where the dispensed product was sent. Important as part of a claim for justifying shipping charges. | 1 | Mand |
|
| PORX_MT060160CA.ServiceDeliveryLocation2 |
|---|
| classCode : "SDLOC" (RoleClass) | 1 | Mand | addr : AD.BASIC Business name: H:Prescription Ship to Address Indicates the location the dispensed medication should be shipped to, at the request of the patient or provider. In some cases drugs need to be delivered to the patient instead of being picked up. In other cases, drugs need to be shipped to the physician's office to replace stock used for the patient. | 1 | Mand |
| |
| |
| |
| |
| |
| |
| |
| |
PORX_MT060160CA.Subject5 Business name: *a:prescribed for Identity of the person for whom the prescription was created. A legal requirement, and also allows the content to be linked to the person's EHR. As a result, this association is mandatory. DispensedItem.person Prescription.person Future use request(true when participation is not present) |
|---|
| typeCode : "SBJ" (ParticipationType) | 1 | Mand | | contextControlCode : "OP" (ContextControl) | 1 | Mand | | patient : Patient | 1 | Mand |
| |
| |
| PORX_MT060160CA.SubsequentSupplyRequest Dispensing instruction for all dispenses subsequent to the first fill. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | effectiveTime : IVL.WIDTH<TS.FULLDATE> Business name: F:Dispense Interval Indicates a minimum amount of time that must occur between dispenses. Helps the prescriber ensure that the patient does not ever receive more than the appropriate amount of medication in a particular timeframe. | 0-1 | Req | repeatNumber : INT.POS Business name: G:Number of Fills The number of times the prescribed quantity is to be dispensed, including the initial standard fill. Used to calculate total prescribed quantity; and also used for compliance checking. Expressed as Number of Fills rather than number of refills due to HL7 modeling constraints. D54.03 DRU.060-02 Claim,415-DF ZDP.15.1 Prescription.numberOfRefills | 0-1 | Req | quantity : PQ.DRUG Business name: D:Fill Quantity The amount of medication to be dispensed to the patient for each normal fill (excluding trial or other special first fills). Limits the quantity of medication in patient's possession at a time. Used in compliance checking Prescription.fillAmount Prescription.maximumDispensedAmount (when SupplyRequest.effectiveTime id populated with an interval) Quantity | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: E:Days Supply The number of days that each standard fill is expected to last. The dispenser must use the administration instructions together with the Days Supply to calculate the total quantity to dispense per fill. May be specified in addition to quantity to indicate the length of time a quantity of 'as needed' medication is expected to last. Useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Also provides guidance to the pharmacy on how much to dispense. Also useful in research. | 0-1 | Req |
|
PORX_MT060160CA.SubstanceAdministrationDefinition Business name: Protocols Documentation of why a prescriber has chosen to prescribe the drug in the manner they have. Allows linking to specific guidelines or protocols. Also used to provide additional detail needed when requesting a 'special access' drug from Health Canada. |
|---|
| classCode : "SBADM" (ActClass) | 1 | Mand | | moodCode : "DEF" (ActMood) | 1 | Mand | id : II Business name: Protocol Identifiers A unique identifier for a specific protocol or guideline which the prescription has been written in accordance with. Enables the communication of a reference to a protocol, study or guideline id, specific to the jurisdiction; Allows providers to reference a protocol/guideline for prescribing to specific situations. This could also be used for justification for prescribing a medication from a particular formulary. E.g., 'Limited Use' medications in Ontario require physicians to use a code indicating that a patient is eligible for this particular medication. | 1 | Mand | | code : "DRUG" (ActCode) | 1 | Mand |
| PORX_MT060160CA.SubstitutionMade Business name: Substitution An indication of what kind of substitution made, if any. May explain why prescribed and dispensed medications differ. A_BillablePharmacyDispense |
|---|
| classCode : "SUBST" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActSubstanceAdminSubstitutionCode) Business name: Substitution Code A code signifying whether a different drug was dispensed from what was prescribed. Indicates that substitution was done (or not). This attribute is mandatory because it is essential to understanding the substitution. DRU.050 Claim.408-D8 A_BillablePharmacyDispense | 1 | Mand | | statusCode : "completed" (ActStatus) | 1 | Mand | reasonCode : (SubstanceAdminSubstitutionReason) Business name: Product Selection Code Indicates the reason for the substitution of (or failure to substitute) the medication from what was prescribed. Standardized reasons for substitution performed (or not performed). Useful in analysis of dispensing patterns. DispensedItem.productSelectionCode D62 ZDP.12 A_BillablePharmacyDispense | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Req |
|
PORX_MT060160CA.SubstitutionPermission Business name: Allowed Substitution A prescriber's instruction that a specific prescribed product be dispensed as is, or not. May have financial and therapeutic conformance ramifications for a patient. A_BillablePharmacyDispense |
|---|
| classCode : "SUBST" (ActClass) | 1 | Mand | | moodCode : "PERM" (ActMood) | 1 | Mand | | code : "G" (ActCode) | 1 | Mand | negationInd : Business name: A:Substitution Not Allowed Indicator If true, indicates that the drug must be dispensed exactly as prescribed Many jurisdictions allow substitution by default and require prescribers to explicitly declare when they do not want substitution. The element is mandatory because it must be explicitly true or false. | 1 | Mand | reasonCode : (SubstanceAdminSubstitutionNotAllowedReason) Business name: Not Allowed Reason The reason why the prescriber has indicated that substitution is not allowed by the dispensing pharmacy. Some jurisdictions demand that a prescriber gives a reason for prohibiting substitution. The field is marked as 'Populated' because the reason for substitution is important to understanding the decision. However when a prescription is being recorded in the pharmacy, the information may not be available. | 1 | Pop |
| | PORX_MT060160CA.SupplyEvent |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActPharmacySupplyType) Business name: B:Dispense Type Indicates the type of dispensing event that is performed. Examples include: Trial Fill, Completion of Trial, Partial Fill, Emergency Fill, Samples, etc. Indicates reason for the size of dispense. Because it defines what type of dispense is occurring, the attribute is mandatory. DispensedItem.activityType D52 ZDP.2 Claim.403-D3 Claim.343-HD A_BillablePharmacyDispense | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: D:Dispensed Processing and Pickup Date Represents the date the dispense product was prepared and when the product was picked up by or delivered to the patient. The dispense processing date and pickup date can be back dated to reflect when the actual processing and pickup occurred. The lower-bound of the period signifies the dispense-processing date whereas the upper-bound signifies the dispense-pickup date. Used by the system in calculating expected exhaustion time. Valuable in compliance checking. This attribute is mandatory because an existing dispense record must at least indicate the date it was processed. ZPB3.9 ZDP.17 (high) DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) A_BillablePharmacyDispense Dispense Date Dispense Date DispensedItem.dispenseDate A_BillablePharmacyDispense | 1 | Mand | quantity : PQ.DRUG Business name: F:Dispensed Quantity The amount of medication that has been dispensed. Includes unit of measure. Critical in understanding the patient's medication profile, both past and current, This is also mandatory to allow determination of the amount that remains to be dispensed against the prescription. D58 ZPB3.4 ZDP.10.1 ZDP.10.2.1 (the fact that it is package is determined by a playing entity) ZDP.9.1 ZDP.9.2.1 (the fact that it is package is determined by a playing entity) DRU.020-01 (Unit, qualifier=38 0r 87) DRU.020-02 (Quantity, qualifier=38 0r 87) DRU.020-03 (qualifier=38 0r 87) Claim.442-E7 Claim.460-ET Claim.600-28 A_BillablePharmacyDispense Quantity DispensedItem.dispensedAmount | 1 | Mand | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: G:Dispensed Days Supply The number of days that the dispensed quantity is expected to last. Useful in monitoring patient compliance. May also be useful in determining and managing certain contraindications ('Fill-Too-Soon', 'Fill-Too-Late', and 'Duration of Therapy'). Thus the attribute is marked as 'populated'. D59(width) ZDP.11 DRU.040-02 (low, qualifier=ZDS, format=804) Claim.405-D5 A_BillablePharmacyDispense Days Supply DispensedItem.daysSupply | 1 | Pop | | product : Product2 | 1 | Mand | | receiver : Receiver2 | 0-1 | Req | | destination : Destination2 | 0-1 | Req |
|
PORX_MT060160CA.SupplyEventFirstSummary Business name: First Dispense Information Provides summary information about the first dispense event on the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: First Dispense Pickup Date Indicates when the first dispense against the prescription was picked up. Useful in establishing start of therapy. Important information for compliance | 0-1 | Req | quantity : PQ.DRUG Business name: First Quantity Dispensed Indicates the amount of medication first dispensed on the prescription. Usually establishes trial quantities for a prescription. Because the quantity should always be known if the first dispense is known, this attribute is mandatory. | 1 | Mand |
| PORX_MT060160CA.SupplyEventFutureSummary Business name: Remaining Dispense Information Provides summary information about what dispenses remain to be performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Total Fills Remaining Indicates the number of remaining dispenses estimated, assuming that each fill is equal to the quantity prescribed for a single fill, rounding up. Indicates the number of dispenses that may still occur. | 0-1 | Req | quantity : PQ.DRUG Business name: B:Total Quantity Remaining Indicates the total remaining undispensed quantity authorized against the prescription. Indicates how much can still be dispensed. | 0-1 | Req |
|
PORX_MT060160CA.SupplyEventLastSummary Business name: Last Dispense Information Provides summary information about the most recent dispense event performed against the prescription Useful in understanding the status of a prescription and in planning for renewals. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE> Business name: Last Dispense Pickup Date Indicates the most recent date on which a dispense on the prescription was picked up. Useful in determining when a prescription will next need to be dispensed. Also provides an indication of compliance. | 0-1 | Req | quantity : PQ.DRUG Business name: Last Quantity Dispensed Indicates the most recent quantity of the drug that was picked up for the prescription. Useful in determining the amount of medication that a patient should have on-hand. Also provides an indication of compliance. Because the quantity should always be known if the last dispense is known, this attribute is mandatory. | 1 | Mand |
| PORX_MT060160CA.SupplyEventPastSummary Business name: Previous Dispense Information Summarizes the dispenses that have happened against the prescription to date. Helps in understanding the status of the prescription and evaluating compliance. At least one of quantity and repeatNumber must be specified. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | repeatNumber : INT.NONNEG Business name: A:Dispensed Fills To-date Indicates the number of dispense events performed against the prescription to date, including trial, partial and complete fills. Useful in tracking the progress of a prescription in prescription. | 0-1 | Req | quantity : PQ.DRUG Business name: B:Dispensed Quantity To-date Depending on the Dispense Aggregate Information Type, this field would contain one of Remaining Total Quantity, First Quantity Dispensed, Last Quantity Dispensed, or Total Supplied Amount. Useful for tracking the progress of a prescription | 0-1 | Req |
|
PORX_MT060160CA.SupplyRequest Business name: Dispense Instructions Specification of how the prescribed medication is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the medication to the patient. A_BillablePharmacyDispense |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | statusCode : (ActStatus) Business name: Prescription Dispensable Indicator This generally mirrors the status for the prescription, but in some circumstances may be changed to 'aborted' while the prescription is still active. When this occurs, it means the prescription may no longer be dispensed, though it may still be administered. Allows a prescriber to say "Finish what you have on hand, but don't get any more." Because the status should always be known, this element is mandatory. | 1 | Mand | effectiveTime : IVL<TS.FULLDATE> Business name: A:Dispensing Allowed Period This indicates the validity period of a prescription (stale dating the Prescription). It reflects the prescriber perspective for the validity of the prescription. Dispenses must not be made against the prescription outside of this period. The lower-bound of the Prescription Effective Period signifies the earliest date that the prescription can be filled for the first time. If an upper-bound is not specified then the Prescription is open-ended or will default to a stale-date based on regulations. Indicates when the Order becomes valid, and when it ceases to be an actionable Order. Some jurisdictions place a 'stale date' on prescriptions that cause them to become invalid a certain amount of time after they are written. This time may vary by medication. ZPB3.9 DRU.040-02 (low, qualifier=07, format=102) DRU.040-02 (low, qualifier=36, format=102) Number of days (width) When will drug be administered?(low) ZDP.17 (high) Last date dispensed(when summary type is 'most recent') Prescription.dispensingInterval(period) Prescription.effectiveDate (low) Prescription.expiryDate (high) | 0-1 | Req | | receiver : Receiver | 0-5 | Req | | destination : Destination1 | 0-1 | Req | | location : Location5 | 1 | Pop | | component : Component3 | 1-5 | Pop |
| PORX_MT060160CA.SupplyRequestItem Business name: Dispense Instruction Details Specification of how the prescribed medication is to be dispensed to the patient. Dispensed instruction information includes the quantity to be dispensed, how often the quantity is to be dispensed, etc. Sets the parameters within which the dispenser must operate in dispensing the medication to the patient. Allows dispensing instructions to be given at specific dispensable drug level for an overall prescribed drug. |
|---|
| classCode : "SPLY" (ActClass) | 1 | Mand | | moodCode : "RQO" (ActMood) | 1 | Mand | quantity : PQ.DRUG Business name: B:Total Prescribed Quantity The overall amount of amount medication to be dispensed under this prescription. Includes any first fills (trials, aligning quantities), the initial standard fill plus all refills. Sets upper limit for medication to be dispensed. Can be used to verify the intention of the prescriber with respect to the overall medication. Used for comparison when determining whether additional quantity may be dispensed in the context of a part-fill prescription. Narcotics must always be specified as a total quantity. | 0-1 | Req | expectedUseTime : IVL.WIDTH<TS.FULLDATE> Business name: A:Total Days Supply The number of days that the overall prescribed item is expected to last, if the patient is compliant with the dispensing and administration of the prescription. Used to specify a total authorization as a duration rather than a quantity with refills. E.g. dispense 30 at a time, refill for 1 year. May also be sent as an estimate of the expected overall duration of the prescription based on the quantity prescribed. This attribute is mandatory because the prescriber (in discussion with the patient) has a better understanding of the days supply needed by the patient. | 1 | Mand | | product : Product1 | 0-1 | Req | | component1 : Component7 | 0-1 | Req | | component2 : Component8 | 1 | Mand |
|
| |
PORX_MT060160CA.WorkingListEvent Business name: Drug Use Categorization of prescriptions based on the intended duration of the prescribed therapy. Useful in establishing compliance for drug renewals and refills. |
|---|
| classCode : "LIST" (ActClass) | 1 | Mand | | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActTherapyDurationWorkingListCode) Business name: D:Treatment Type Describes the categorization of the therapy envisioned by this prescription (e.g. Continuous/Chronic, Short-Term/Acute and "As-Needed). Allows categorizing prescription for presentation. May influence detection of duplicate therapy. May also be used to affect how DUR processing is completed. The field is marked as "populated" because the intended duration of the therapy should generally be known at prescribe time. However in some circumstances, it may not be known whether a therapy will be short-term or long-term. Prescription type Prescription.drugUseIndicator | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060170CA.AdministrationEffectivePeriod |
|---|
value : IVL<TS.FULLDATE> Business name: Administration Effective Period For a prescription indicates the period for which the patient was deemed to be taking the drug. Filter the result set to include only those medication records (prescription order, prescription dispense and other medication) for which the patient was deemed to be taking the drug. Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries. | 1 | Mand |
| | PORX_MT060170CA.AmendedInTimeRange |
|---|
value : IVL<TS.FULLDATETIME> Business name: Amended In Time Range Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to 'retrieve everything that has been amended since xxx'. Allows the requester to specify the event period of interest for the retrieval of medication records. Useful for constraining run-away queries. | 1 | Mand |
|
| PORX_MT060170CA.DiagnosisCode |
|---|
value : (DiagnosisValue) Business name: Diagnosis Code Indicates that the result set is to be filtered to include only those records pertaining to the specified diagnosis indication code. Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications. | 1 | Mand |
| | PORX_MT060170CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: Drug Code Indicates that the result set is to be filtered to include only those records pertaining to the specified drug. The code may refer to an orderable medication or a higher level drug classification. Allows for the retrieval of patient prescriptions and/or dispenses based on a specific medication that was ordered and/or dispensed. This will most commonly be used to filter for therapeutic classifications such as "Anti-hypertensives". | 1 | Mand |
|
| PORX_MT060170CA.IncludeEventHistoryIndicator |
|---|
value : Business name: Include Event History Indicator Indicates whether or not history events associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information. "Pending" changes will be returned regardless of the setting of this flag. Allows for the flexibility of omitting/including history in the retrieval of the requested information. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
| | PORX_MT060170CA.IncludeIssuesIndicator |
|---|
value : Business name: Include Issues Indicator Indicates whether or not Issues (detected and/or managed) attached to the prescriptions, dispenses and other active medication records are to be returned along with the detailed information. Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
|
| PORX_MT060170CA.IncludeNotesIndicator |
|---|
value : Business name: Include Notes Indicator Indicates whether or not notes attached to the prescription, dispenses and other active medication records are to be returned along with the detailed information. Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
| | PORX_MT060170CA.IncludePendingChangesIndicator |
|---|
value : Business name: Include Pending Changes Indicator Indicates whether to include future changes (e.g. status changes that aren't effective yet) associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information. Allows for the flexibility of omitting/including future events in the retrieval of the requested information. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
|
| PORX_MT060170CA.MostRecentDispenseForEachRxIndicator |
|---|
value : Business name: Most Recent Dispense for each Rx Indicator Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription. Allows the returning of at most one prescription dispense record per a prescription. The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result. Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
| | PORX_MT060170CA.OtherIndicationCode |
|---|
value : (ActNonConditionIndicationCode) Business name: Other Indication Code Indicates that the result set is to be filtered to include only those records pertaining to the specified non-condition-related indication code. Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications. | 1 | Mand |
|
| | PORX_MT060170CA.PatientBirthDate |
|---|
value : TS.DATE Business name: Patient Birth Date Indicates the date on which the patient was born. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
|
| PORX_MT060170CA.PatientGender |
|---|
value : (AdministrativeGender) Business name: Patient Gender Indicates the gender (sex) of the patient. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060170CA.PatientID |
|---|
value : II Business name: B:Patient ID Identifier of the patient who is the subject of the patient medication query. Filter the result set to include only those records pertaining to the patient with this Id. Allows filtering of result set by patient Id. This is a mandatory field because a patient must be specified for the query to be valid | 1 | Mand |
|
| PORX_MT060170CA.PatientName |
|---|
value : PN.BASIC Business name: C:Patient Name The name by which the patient is known. Used to confirm the identity of the patient for the query and is therefore mandatory. | 1 | Mand |
| | PORX_MT060170CA.SymptomCode |
|---|
value : (SymptomValue) Business name: Symptom Code Indicates that the result set is to be filtered to include only those records pertaining to the specified symptom indication code. Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications. | 1 | Mand |
|
|
|
|
|---|
| PORX_MT060180CA.AdministrationEffectivePeriod |
|---|
value : IVL<TS.FULLDATE> Business name: Administration Effective Period Indicates the administration period for which the request/query applies. Filter the result set to include only those medication records (prescription order, prescription dispense and other active medication) for which the patient was deemed to be taking the drug within the specified period. Allows the requester to specify the administration period of interest for the retrieval. Useful for constraining run-away queries. | 1 | Mand |
| | PORX_MT060180CA.AmendedInTimeRange |
|---|
value : IVL<TS.FULLDATETIME> Business name: Amended in Time Range Indicates that the returned records should be filtered to only include those which have been amended in some way (had status changed, been annotated, prescription was dispensed, etc.) within the indicated time-period. This will commonly be used to retrieve everything that has been amended since xxx. Allows the requester to specify the event period of interest for the retrieval of medication records. Useful for constraining run-away queries. | 1 | Mand |
|
| PORX_MT060180CA.DiagnosisCode |
|---|
value : (DiagnosisValue) Business name: Diagnosis Code Indicates that the result set is to be filtered to include only those records pertaining to the specified diagnosis indication code. Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications. | 1 | Mand |
| | PORX_MT060180CA.DrugCode |
|---|
value : (ClinicalDrug) Business name: Drug Code Indicates that the result set is to be filtered to include only those records pertaining to the specified drug. The code may refer to an orderable medication or a higher level drug classification. Allows for the retrieval of patient prescriptions and/or dispenses based on a specific medication that was ordered and/or dispensed. This will most commonly be used to filter for therapeutic classifications such as "Anti-hypertensives". | 1 | Mand |
|
| PORX_MT060180CA.IncludeEventHistoryIndicator |
|---|
value : Business name: Include Event History Indicator Indicates whether or not history events associated with a prescription order, prescription dispense and/or other active medications are to be returned along with the detailed information. "Pending" changes will be returned regardless of the setting of this flag. Allows for the flexibility of omitting/including history in the retrieval of the requested information. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
| | PORX_MT060180CA.IncludeIssuesIndicator |
|---|
value : Business name: Include Issues Indicator Indicates whether or not Issues (detected and/or managed) attached to the prescriptions, dispenses and other active medication records are to be returned along with the detailed information. Allows for the flexibility of omitting/including issues in the retrieval of medication detail profile data. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
|
| PORX_MT060180CA.IncludeNotesIndicator |
|---|
value : Business name: Include Notes Indicator Indicates whether or not notes attached to the prescription, dispenses and other active medication records are to be returned along with the detailed information. Allows for the flexibility of omitting/including notes in the retrieval of information for medication profile detail data. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
| | PORX_MT060180CA.IncludePendingChangesIndicator |
|---|
value : Business name: Include Pending Changes Indicator Indicates whether to include future changes (e.g. status changes that aren't effective yet) associated with a prescription order, prescription dispense and/or active medications are to be returned along with the detailed information. Allows for the flexibility of omitting/including future events in the retrieval of the requested information. Because the attribute is boolean, it must explicitly indicate a 'TRUE' or 'FALSE', and thus it is mandatory. | 1 | Mand |
|
| PORX_MT060180CA.IssueFilterCode |
|---|
value : (IssueFilterCode) Business name: Issue Filter Code Indicates whether records to be returned (e.g. prescription order, prescription dispense and/or other medication) should be filtered to those with at least one persistent un-managed issue (against the record), with at least one persistent issues or should return all records, independent of the presence of persistent issues. By filtering returned records to include only those which have unmanaged issues or any issues at all, allows a provider to focus on those aspects of care where extra attention is needed. Because the attribute must be known, it is mandatory. | 1 | Mand |
| | PORX_MT060180CA.MostRecentByDrugIndicator |
|---|
value : Business name: Most Recent By Drug Indicator Indicates whether or not the medication records are to be retrieved based on the most recent by Drug Code. If true, only the most recent prescription, dispense or other active medication for a particular drug generic classification will be returned. The default is 'FALSE' indicating that retrieval of prescription, dispense and other active medication records should not be limited to one per drug. Helps decrease the volume of records returned, while still maintaining information on all drugs that the patient is on. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
|
| PORX_MT060180CA.MostRecentDispenseForEachRxIndicator |
|---|
value : Business name: Most Recent Dispense for each Rx Indicator Indicates whether or not a prescription dispenses returned on a query should be limited to only the most recent dispense for a prescription. Allows the returning of at most one prescription dispense record per a prescription. The default is 'TRUE' indicating that retrieval should be for only the most recent dispense for a prescription is to be included in a query result. Helps to trim down volume of query response by eliminating multiple dispenses for the same prescription. Because this is a boolean attribute whose value must be known to evaluate the query, the attribute is mandatory. | 1 | Mand |
| | PORX_MT060180CA.OtherIndicationCode |
|---|
value : (ActNonConditionIndicationCode) Business name: Other Indication Code Indicates that the result set is to be filtered to include only those records pertaining to the specified non-condition-related indication code. Allows for the retrieval of patient's prescriptions and/or dispenses based on prescribing indications. | 1 | Mand |
|
| PORX_MT060180CA.OtherMedicationRecordId |
|---|
value : II Business name: E:Other Medication Record Id Identifier of the other active medication record for which detailed information is to be retrieved. Allows for the retrieval of medication records based on a specific active medication record. | 1 | Mand |
| |
