Interactions Report for Version: R02.04.02 (MR2009 Planned Release Delta)
Interactions Table of Contents
Package Locations Table of Contents
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Accept Ack Poll for Next Message |
|---|
| Message |
|
|
|
|
|---|
| Exception Ack in Response to Poll Request |
|---|
| Message |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| |
| |
COCT_MT011001CA.PatientCareProvisionEvent  Business name: Care Compositions A care composition is a record with two purposes. It indicates that care of a given type has occurred or is occurring. It also acts as a collector for the events that happened during care, including who is responsible for the care provided. Allows linking records to encounters, condition and care-based compositions. Useful for searching and navigation of the patient's record. |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: B: Care Composition Identifier Unique identifier of an encounter, condition or care-based collection. Allows care compositions to be uniquely identified and referenced. IMMUNIZATION INTERPRETATION.REFERENCED DATA | 0-1 | Req | code : (ActCareEventType)  Business name: A: Care Composition Type Identifies the kind of composition represented. Examples include encounters ("Emergency Encounter", "Long Term Care Encounter", etc), health condition (episode)-based collections (e.g. "Diabetes", "Hypertension", etc) and general care-based collections such as "gynecological care". Allows care compositions to be captured and categorized at different levels of abstraction, and is therefore mandatory. EPHS: vocab concepts needed for LAB ID, Special Considerations ID etc. IMMUNIZATION INTERPRETATION.REFERENCED DATA | 1 | Mand | effectiveTime : IVL<TS.DATETIME>  Business name: Care Composition Effective Date | 0-1 | Req | | admitter : Admitter | 0-10 | Req | | attender : Attender | 0-10 | Req | | location : Location | 0-1 | Req |
| |
|
|
|
|---|
COCT_MT050007CA.IdentifiedEntity  Business name: Other Identifiers This role object is used to store any other patient identification identifiers. Used for patient identification. |
|---|
classCode : "IDENT" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: K:Other Identifier Alternate Identifiers for the Patient (e.g., Drivers License number, Health insurance number). Other identification numbers associated with identifying a patient. | 1 | Mand | code : (OtherIdentifiersRoleType)  Business name: J:Other Identifier Type Describes the identification type (driver's license, etc.) Used to set the type of identier | 1 | Pop |
| COCT_MT050007CA.IdentifyingCharacteristicsObservationEvent  Business name: Patient Identifying Characteristics For this model, the observation is a description of patient characteristics used for identification. Used for patient identification when the client registry is not available. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (PatientCharacteristicObservationType)  Business name: Identifying Characteristics Observation Type Describes the observation type. Used to categorize this observation event. For this model, the observation is a description of patient characteristics used for identification. | 1 | Mand | value :  Business name: I:Patient Characteristics Text A text attribute that is specifically used to describe identifying characteristics of a patient. When a lab does not have access to the client registry to identify the patient, additional information is helpful in patient identification. This text description allows for non-coded patient descriptive details which don't change measurable over time and can be used to assist in patient identification. | 1 | Mand |
|
COCT_MT050007CA.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 : SET<II.PUBLIC>  Business name: A:Patient Identifier The cardinality of patient identifiers is up to 3 based on the use case to support communication of a local and jurisdictional identifier along with the national identifier. | 1-3 | Mand | addr : AD.BASIC  Business name: E:Patient Address | 1 | Pop | telecom : LIST<TEL.PHONEMAIL>  Business name: F:Patient Contact Phone and E-Mails | 0-5 | Req | certificateText :  Business name: L:Patient Health Card Version Code | 0-1 | Req | | patientPerson : Person | 1 | Pop | | subjectOf : Subject | 0-1 | Req |
| | COCT_MT050007CA.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 populated because the patient's name is frequently necessary for positive identification of the patient in the jurisdictional client registry. | 1 | Pop | administrativeGenderCode : (AdministrativeGender)  Business name: D: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. | 1 | Pop | birthTime : TS.DATETIME  Business name: C: Patient Birth Datetime Indicates the date on which the patient was born. Used to confirm patient identity. | 1 | Pop | deceasedInd :  Business name: G:Patient Deceased Indicator Indicates whether the patient is deceased. | 0-1 | Req | deceasedTime : TS.DATETIME  Business name: H:Patient Deceased Datetime The date/time the patient died or was ruled "deceased." | 0-1 | Req | | asIdentifiedEntity : IdentifiedEntity | 0-4 | Req |
|
|
|
|
|
|---|
COCT_MT050201CA.Patient  Business name: Patient A person who is receiving or may receive healthcare services and has had their identity previously confirmed Used when patienty identity confirmation is handled as a distinct business process rather than as part of each transaction. Allows transactions to be linked to a specific patient. |
|---|
classCode : "PAT" (RoleClass) | 1 | Mand | id : SET<II.BUS>  Business name: A:Patient Identifier Unique identifier issued as part of the patient identity verification process. Allows a patient to be referred to unambiguously. Because this is the principal mechanism for identifying patients to electronic systems, the attribute is mandatory. The cardinality of patient identifiers is up to 3 based on the use case to support communication of a local and jurisdictional identifier along with the national identifier. 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-3 | 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). Only the identifier attribute is intended to be persisted, with the remaining attributes confirmed against the provider registry. Information used to identify the patient and confirm their identity against the client registry. |
|---|
classCode : "PAT" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: A:Patient Identifier 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 patients to computer systems, the attribute is mandatory. If an identifier is not known, it should be looked up using the 'client registry' capabilities of the EHR application. The cardinality of patient identifiers is up to 3 based on the use case to support communication of a local and jurisdictional identifier along with the national identifier. 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-3 | 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 to the underlying client registry application Used, with other patient identity attributes, to confirm patient identity. This element is 'populated' because the patient's name is necessary for positive identification of the patient in the jurisdictional client registry, however in some circumstances it may not exist in the registry (e.g. newborn). 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 | Pop | administrativeGenderCode : (AdministrativeGender)  Business name: F:Patient Gender Indicates the gender (sex) of the patient as known by the client registry. Complex genetic genders are handled as observations if they are considered relevant. Used to confirm patient identity. The element is mandatory because the patient's gender is necessary for positive identification of the patient in the jurisdictional client registry and should always be known. | 1 | Pop | birthTime : TS.DATE  Business name: E:Patient Birth Date Indicates the date on which the patient was born, as known by the client registry. Used to confirm patient identity. This element is 'populated' because the patient's birth date is necessary for positive identification of the patient in the jurisdictional client registry. However, there may be circumstances where the date of birth is not known to the registry. | 1 | Pop |
|
|
|
|
|---|
COCT_MT050207CA.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 is used when the patient is not known to the client registry but information still needs to be communicated. E.g. lab or drug reporting to PHS for an unconscious or otherwise unidentifiable patient. |
|---|
classCode : "PAT" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: A:Patient Identifier Unique identifier assigned to a person, possibly by a local system or some other non-client-registry identifier. Allows a patient to be referred to unambiguously. Because this CMET deals with patients not confirmable against a client registry, it's possible that no identifier will be known and therefore the attribute is only 'populated'. The cardinality of patient identifiers is up to 3 based on the use case to support communication of a local and jurisdictional identifier along with the national identifier. 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-3 | Pop | addr : AD.BASIC  Business name: C:Patient Contact Address Physical address for the patient where they may be visited or found. Contact information specific to the patient for a particular action (prescription, lab test, etc.) will be conveyed as part of the payload. Provides basic contact information for the patient. 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 and/or e-mail addresses intended as the principal means of contact for the patient. Contact information specific to the patient for a particular action (prescription, lab test, etc.) will be conveyed as part of the payload. Provides basic contact information for the patient. 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_MT050207CA.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. Used by to help identify the patient and also when referring to the patient The element is populated because the patient's name is important for display. However, there may be circumstances where a name is not known by the reporting system. 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 | Pop | administrativeGenderCode : (AdministrativeGender)  Business name: F:Patient Gender Indicates the gender (sex) of the patient as known by the client registry. Complex genetic genders are handled as observations if they are considered relevant. Used to confirm patient identity. May affect clinical decision support such as drug dosing, lab test appropriateness, etc. The element is 'populated' because there are some situations where the patient's gender may not be known by the sending system when dealing with non-client registry patients. C40 eScript:PTT.040 3 Sex PID.8 Patient.305-C5 PID.8 | 1 | Pop | birthTime : TS.DATE  Business name: E:Patient Birth Date Indicates the date on which the patient was born as known by the client registry. Used to confirm patient identity. May also influence clinical decision support such as dosage and therapy appropriateness. The element is populated because the patient's birth date may not be known, particularly for patients not found in the client registry. C34 PTT.020 A.2b HC-SA PID.7 patient.304-C4 PID.7 | 1 | Pop |
|
|
|
|
|---|
COCT_MT050208CA.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 is that captured within the client registry record for the patient. |
|---|
classCode : "PAT" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: A:Patient Identifier 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 patients to computer systems, the attribute is mandatory. The cardinality of patient identifiers is up to 3 based on the use case to support communication of a local and jurisdictional identifier along with the national identifier. 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-3 | Mand | addr : AD.BASIC  Business name: C:Patient Contact Address Physical address for the patient where they may be visited or found. Contact information specific to the patient for a particular action (prescription, lab test, etc.) will be conveyed as part of the payload. Provides basic contact information for the patient avoiding the need to separately query the client registry. 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 and/or e-mail addresses intended as the principal means of contact for the patient. Contact information specific to the patient for a particular action (prescription, lab test, etc.) will be conveyed as part of the payload. Provides basic contact information for the patient avoiding the need to separately query the client registry. 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_MT050208CA.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 to the client registry. Potentially used by PoS systems to confirm patient identity. Also acts as the visual confirmation to the user about the patient being viewed. The element is populated because the patient's name is important for display. However, there may be circumstances where a name is not available in the registry (e.g. newborns). 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 | Pop | administrativeGenderCode : (AdministrativeGender)  Business name: F:Patient Gender Indicates the gender (sex) of the patient as known by the client registry. Complex genetic genders are handled as observations if they are considered relevant. Used to confirm patient identity. May affect clinical decision support such as drug dosing, lab test appropriateness, etc. Element is mandatory because the patient's gender is necessary for positive identification of the patient in the jurisdictional client registry and should always be known. C40 eScript:PTT.040 3 Sex PID.8 Patient.305-C5 PID.8 | 1 | Pop | birthTime : TS.DATE  Business name: E:Patient Birth Date Indicates the date on which the patient was born as known by the client registry. Used to confirm patient identity. May also influence clinical decision support such as dosage and therapy appropriateness. The element is populated because the patient's birth date is necessary for positive identification of the patient in the jurisdictional client registry. However, in some cases the date of birth may not be known to the client registry C34 PTT.020 A.2b HC-SA PID.7 patient.304-C4 PID.7 | 1 | Pop |
|
|
|
|
|---|
| |
| COCT_MT050303CA.NonPersonLivingSubject |
|---|
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 | | patientNonPersonLivingSubject : NonPersonLivingSubject | 1 | Mand |
|
|
|
|
|---|
| COCT_MT080100CA.Content  Business name: Content Role Associates the specimen material (entity) with one or more containers (which contain that material). Allows for the communication of any risk associated with the containers (containing the specimen material). |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | | container : Container | 1 | Mand |
|
COCT_MT080100CA.IdentifiedEntity  Business name: Other Specimen Identifications Associated specimen identifiers. For referral and redirected orders, this information helps keep track of the different id's assigned during each phase of processing. |
|---|
classCode : "IDENT" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Other Specimen Identifiers Associated specimen identifiers. For referral and redirected orders, this information helps keep track of the different id's assigned during each phase of processing. | 1 | Mand | code : (SpecimenIdentifierRoleType)  Business name: Other Specimen Identifier Type Describes the type of other specimen identifier (referral, primary, etc.) Categorized the type of role identifier. | 1 | Pop | | assigningOrganization : Organization | 0-1 | Req |
| COCT_MT080100CA.Material  Business name: Specimen Material This entity object is the specimen material itself. The specimen material is of primary importance when communicating a lab result. At least one of code and description must be present and non-null |
|---|
classCode : "MAT" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : CD.LAB (HumanLabSpecimenEntityType)  Business name: V:Specimen Code The code of the specimen material collected e.g. skin, blood, etc. The specimen code differentiates testing types, methods, and resulting processing of specimen material. | 0-1 | Req | desc :  Business name: W:Specimen Text Any descriptive specimen information not sufficiently communicated by the code attribute. Used when information is not able to be coded or represented using the available other attributes. | 0-1 | Req | | asIdentifiedEntity : IdentifiedEntity | 0-10 | Req | | asContent : Content | 0-1 | Req |
|
COCT_MT080100CA.Organization  Business name: Specimen Scoping Organization Identifies the organization or group assigning the associated specimen identifier. To identify or name the specimen identifier scoping organization. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.PUBLIC  Business name: Organization Identifier A unique identifier for the organization Allows the organization to be referenced when determining privileges and for drill-downs to retrieve additional information. Because of its importance, the attribute is mandatory. | 1 | Mand | name :  Business name: Organization Name Identifies the name of the organization Allows for human recognition of the organization as well as confirmation of the identifier. As a result, the attribute is mandatory. | 1 | Mand |
| |
| COCT_MT080100CA.Product  Business name: is product of Associates the specimen (role) with the collection procedure (information). For communicating the associated specimen collection procedure information. |
|---|
typeCode : "PRD" (ParticipationType) | 1 | Mand | | specimenCollectionProcedureEvent : SpecimenCollectionProcedureEvent | 1 | Pop |
|
COCT_MT080100CA.Specimen  Business name: Specimen Role The specimen role represents the information regarding a material collected from a patient to serve as a specimen for testing. |
|---|
classCode : "SPEC" (RoleClass) | 1 | Mand | id : II.BUS  Business name: A:Specimen Identifier A unique identifier for the specimen. Frequently the accession number which often uniquely identifies the specimen is used as the unique specimen identifier in communications. However, accessioning may group multiple specimens (identified) under one accession number. Therefore, it is recommended that this be truly the specimen identifier and not the accession number. For a referral, this attribute should be Required so it is reflected back in the result. If Lab A has collected and or done something to the specimen, then the identifier would be sent. A unique specimen identifier is necessary for specimen tracking and management. | 0-1 | Req | code : "P" (RoleCode)  Business name: Specimen Identifier Type Describes the type of specimen identifier (referral, primary, etc.) Categorized the type of role identifier. | 1 | Mand | | specimenMaterial : Material | 1 | Mand | | subjectOf : Subject2 | 0-10 | Req | productOf : Product  The specimen is a product of a specimen collection procedure. This productOf participation associates an identified specimen with the documentation of that specimen's collection process. | 0-1 | Req |
| COCT_MT080100CA.SpecimenCollectionProcedureEvent  Business name: Specimen Collection Procedure This is the procedure act which describes the process/procedure used to collect the associated specimen. For certain laboratory tests, the specimen collection procedure information is relevant in determining the result value. |
|---|
classCode : "SPECCOLLECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | text :  Business name: G:Specimen Collection Text Used to describe any additional information regarding the specimen collection procedure or the collected material, e.g. left ear; where "ear" is atomically represented by the Natural entity code but the "left" is not able, at this time, to also be communicated within the Natural entity. This attribute is not used for notes or comments regarding the specimen collection process. Notes and annotations are documented using the Annotation CMET. The text attribute documents any additional information regarding this specimen collection procedure event that is not able to be communicated using the other attribution of this act e.g. for granularity of coding reasons. | 0-1 | Req | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: E:Specimen Collection Date/Time The date/time the specimen was collected. This can be a date/time interval (start - stop). The time may not always be known, but a date should always be entered. The specimen collection date/time is relevant to the testing and resulting outcome of that specimen for some laboratory tests. | 0-1 | Req | methodCode : (SurgicalPathologyMethodCode)  Business name: Specimen Collection Procedure Method Method of specimen collection used primariy for Surgical Pathology. | 0-1 | Req | | performer : Performer | 0-2 | Req | | subjectOf : Subject1 | 0-10 | Req |
|
| COCT_MT080100CA.Subject2  Business name: has transport information Associates the specimen (role) with one to ten transportation event acts. For communicating specimen transit date/time as well as specimen received date/time. |
|---|
typeCode : "SBJ" (ParticipationType) | 1 | Mand | | transportationEvent : TransportationEvent | 1 | Pop |
|
COCT_MT080100CA.TransportationEvent  Business name: Specimen Process Steps The specimen is subject to one or more process steps. e.g. the specimen receive date is documented using a process step object, specimen action codes are also represented and communicated using this process step object. At this time, only the transportation specimen process steps are in scope for lab messaging. |
|---|
classCode : "TRNS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : "SREC" (ActSpecimenTransportationCode)  Business name: P:Transportation Type Describes the type of process step being documented and communicated. Value is fixed to specimen received. Categorizes the type of transportation act being communiated. | 0-1 | Req | statusCode : (ActStatus)  Business name: R:Transportation Status The state or status of this transportation process step. Indicates (along with the mood) whether this act's action has been completed or is still being acted upon (or has yet to be acted upon). | 0-1 | Req | effectiveTime : IVL<TS.DATETIME>  Business name: Q:Transportation Date/Time The date/time the process step took place or the duration of that step (days or time in transit, start time, end time). Holds the date/time the process step took place. This attribute is especially important for those process steps which document the date/time the process happened (specimen received date/time). | 0-1 | Req |
|
|
|
|
|---|
COCT_MT090102CA.AssignedEntity  Business name: Healthcare Worker The person assigned to carry out the associated action (linked by a participation) and/or the organization/group under whose authority they are acting. Critical to tracking responsibility and performing follow-up. The CMET supports both licensed providers as well as non-licensed providers such as technicians, receptionists, etc. |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: A: Healthcare Worker Identifier Unique identifier the person involved in the action. Allows unique identification of the person which can be critical for authentication, permissions, drill-down and traceability and is therefore mandatory. | 1-3 | Mand | | assignedPerson : Person | 1 | Mand | | representedOrganization : Organization | 0-1 | Req |
| | COCT_MT090102CA.HealthCareProvider |
|---|
classCode : "PROV" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: C: License Number The license number issued to the provider and relevant to the current action. If the identifier used in the root of the CMET is the same as the license number, the license number should be sent in both places. Allows lookup on college website, confirmation of identity, etc. Regulations occasionally require license numbers to be specified as part of clinical records. | 1 | Mand |
|
COCT_MT090102CA.Organization  Business name: Responsible organization Identifies the organization or group on whose behalf the action is performed. Used for determining responsibility and potentially confirming permissions. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.PUBLIC  Business name: D: Organization identifier A unique identifier for the organization Allows the organization to be referenced when determining privileges and for drill-downs to retrieve additional information. Because of its importance, the attribute is mandatory. | 1 | Mand | name :  Business name: E: Organization Name Identifies the name of the organization Allows for human recognition of the organization as well as confirmation of the identifier. As a result, the attribute is mandatory. | 1 | Mand |
| COCT_MT090102CA.Person  Business name: Acting Person Describes the person actually involved in the action. Even when an organization is taking responsibility, a person is generally involved in the work. |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: B: Healthcare Worker Name The name of the involved person. This is a human-readable name and is essential for validation of the person. As a result, the attribute is mandatory | 1 | Pop | | asHealthCareProvider : HealthCareProvider | 0-1 | Req |
|
|
|
|
|---|
COCT_MT090108CA.AssignedEntity  Business name: Healthcare Worker The person organization assigned to carry out the associated (linked by a participation) action and/or the organization under whose authority they are acting. All attributes other than the various identifiers are expected to be retrieved from the provider registry. Critical to tracking responsibility and performing follow-up. The CMET supports both licensed providers as well as non-licensed providers such as technicians, receptionists, etc. |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: A:Healthcare Worker Identifier Unique identifier the person involved in the action. Allows unique identification of the person which can be critical for authentication, permissions, drill-down and traceability and is therefore mandatory. | 1-3 | Mand | code : (HealthCareProviderRoleType)  Business name: B: Healthcare Worker Type Indicates the "kind" of healthcare participant, such as "physician", "dentist", "lab technician", "receptionist", etc. Provides context around the actions of the participant and is therefore mandatory. | 1 | Mand | telecom : SET<TEL.PHONEMAIL>  Business name: E: Healthcare Worker Phone and Emails Indicates phone and/or e-mail addresses at which the healthcare worker can be reached. This is the most commonly used piece of contact information and is returned here to avoid unnecessary queries of the provider registry. | 0-5 | Req | | assignedPerson : Person | 1 | Mand | | representedOrganization : Organization | 0-1 | Req |
| | COCT_MT090108CA.AssignedOrganization |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | code : (HealthcareOrganizationRoleType)  Business name: G: Organization Type Identifies the type of organization on whose behalf the action was taken. E.g. Pharmacy, Clinic, Hospital, etc. Provides context to the action and is therefore mandatory. | 1 | Mand | telecom : SET<TEL.PHONEMAIL>  Business name: I: Organization Phone and Emails Identifies contact information for the responsible organization. This is the most commonly used contact information and is returned to avoid unnecessary queries against the client registry. | 0-5 | Req |
|
| COCT_MT090108CA.HealthCareProvider |
|---|
classCode : "PROV" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: D: License Number The license number issued to the provider and relevant to the current action. If the identifier used in the root of the CMET is the same as the license number, the license number should be sent in both places. Detailed information about the status and effective period of licenses must be retrieved from the provider registry. Allows lookup on college website, confirmation of identity, etc. Regulations occasionally require license numbers to be specified as part of clinical records. | 1 | Mand |
| COCT_MT090108CA.Organization  Business name: Responsible organization Identifies the organization on whose behalf the action is performed. Used for determining responsibility and potentially confirming permissions. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.PUBLIC  Business name: F: Organization identifier A unique identifier for the organization Allows the organization to be referenced when determining privileges and for drill-downs to retrieve additional information. Because of its importance, the attribute is mandatory. | 1 | Mand | name :  Business name: H: Organization Name Identifies the name of the organization Allows for human recognition of the organization as well as confirmation of the identifier. As a result, the attribute is mandatory. | 1 | Mand | | assignedOrganization : AssignedOrganization | 0-1 | Req |
|
|
|
|
|
|---|
COCT_MT090302CA.AssignedDevice  Business name: Application A reference to a system/application related to healthcare information. Allows an application to be uniquely identified. |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II.BUS  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 | manufacturerModelName :  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 | id : II.BUS  Business name: Repository Identifier A unique identifier for the EHR repository. Allows repositories to be uniquely identified for linking or grouping purposes and is therefore mandatory. | 1 | Mand | | assignedRepository : Repository | 1 | Mand | | representedRepositoryJurisdiction : RepositoryJurisdiction | 1 | Mand |
| |
|
|
|
|
|---|
COCT_MT090502CA.AssignedEntity  Business name: Healthcare Organization The organization under whose authority the associated action (linked by a participation) was performed. Critical to tracking responsibility and performing follow-up. |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | | representedOrganization : Organization | 1 | Mand |
| COCT_MT090502CA.Organization  Business name: Responsible organization Identifies the organization or group on whose behalf the action is performed. Used for determining responsibility and potentially confirming permissions. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.PUBLIC  Business name: D: Organization identifier A unique identifier for the organization Allows the organization to be referenced when determining privileges and for drill-downs to retrieve additional information. Because of its importance, the attribute is mandatory. | 1 | Mand | name :  Business name: E: Organization Name Identifies the name of the organization Allows for human recognition of the organization as well as confirmation of the identifier. As a result, the attribute is mandatory. | 1 | Mand |
|
|
|
|
|---|
COCT_MT090508CA.AssignedEntity  Business name: Healthcare Organization The organization under whose authority the associated (linked by a participation) action is performed All attributes other than the various identifiers are expected to be retrieved from the provider registry. Critical to tracking responsibility and performing follow-up. |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | | representedOrganization : Organization | 1 | Mand |
| | COCT_MT090508CA.AssignedOrganization |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | code : (HealthcareOrganizationRoleType)  Business name: F: Organization Type Identifies the type of organization on whose behalf the action was taken. E.g. Pharmacy, Clinic, Hospital, etc. Provides context to the action and is therefore mandatory. | 1 | Mand | telecom : SET<TEL.PHONEMAIL>  Business name: H: Organization Phone and Emails Identifies contact information for the responsible organization. This is the most commonly used contact information and is returned to avoid unnecessary queries against the client registry. | 0-5 | Req |
|
COCT_MT090508CA.Organization  Business name: Responsible organization Identifies the organization on whose behalf the action is performed. Used for determining responsibility and potentially confirming permissions. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.PUBLIC  Business name: E: Organization identifier A unique identifier for the organization Allows the organization to be referenced when determining privileges and for drill-downs to retrieve additional information. Because of its importance, the attribute is mandatory. | 1 | Mand | name :  Business name: G: Organization Name Identifies the name of the organization Allows for human recognition of the organization as well as confirmation of the identifier. As a result, the attribute is mandatory. | 1 | Mand | | assignedOrganization : AssignedOrganization | 1 | Mand |
|
|
|
|
|---|
| |
COCT_MT110101CA.PayorRole  Business name: Account Payor A Payor is the organization whose is responsible for the payment. |
|---|
classCode : "PAYOR" (RoleClass) | 1 | Mand | id : SET<II.BUS>  Business name: Payor identifier assigned by adjudicator | 1 | Mand |
|
|
|
|
|---|
| |
| COCT_MT110200CA.PayeeLanguage  Business name: Payee Language Coded value denoting specific language in which the monograph is written. |
|---|
languageCode : (HumanLanguage)  Business name: Payee Person Language | 1 | Mand | modeCode : (LanguageAbilityMode)  Business name: Language of Communication A value presenting the method of expression of the language. | 1 | Mand | preferenceInd :  Business name: Preferred Language Indicator | 0-1 | Req |
|
| |
COCT_MT110200CA.PayeeRole  Business name: Payee Role Role of payee - being played by Organisation, Person Payee: (1) Provider or designate organization with identifier plays the role of Payee - PayeeRole.id only (no Account, Person info) (2) Payee is an individual listed on the insurance (e.g. policy holder or covered party) - PayeeRole.id must not be specified - Specify PayeeRelationshipRole (e.g. Policy Holder) - Optionally specify name, addr, language, bank account info - Account bank info is likely on file with Payor and is NOT required for direct deposit - PayeePerson.addr is likely on file with Payor and is NOT required for mailing of cheque (3) Payee is an individual not listed on the insurance (e.g. guarantor) - PayeeRole.id must not be specified - Specify PayeeRelationshipRole (e.g. Guarantor) - Optionally specify name, addr, language, bank account info - Account bank info is likely NOT on file with Payor and is required for direct deposit - PayeePerson.addr is likely NOT on file with Payor and is required for mailing of cheque |
|---|
classCode : "PAYEE" (RoleClass) | 1 | Mand | id : SET<II.BUS>  Business name: payee identifier Policy Holder or covered party Payee: (1) Provider or designate organization with identifier plays the role of Payee - PayeeRole.id only (no Account, Person info) (2) Payee is an individual listed on the insurance (e.g. policy holder or covered party) - PayeeRole.id must not be specified - Specify PayeeRelationshipRole (e.g. Policy Holder) - Optionally specify name, addr, language, bank account info - Account bank info is likely on file with Payor and is NOT required for direct deposit - PayeePerson.addr is likely on file with Payor and is NOT required for mailing of cheque (3) Payee is an individual not listed on the insurance (e.g. guarantor) - PayeeRole.id must not be specified - Specify PayeeRelationshipRole (e.g. Guarantor) - Optionally specify name, addr, language, bank account info - Account bank info is likely NOT on file with Payor and is required for direct deposit - PayeePerson.addr is likely NOT on file with Payor and is required for mailing of cheque | 0-1 | Req | | Choice: payeeChoice : PayeeChoice | 0-1 | Req | | »» payeePerson : PayeePerson | 0-1 | Opt | | »» payeeOrganization : PayeeOrganization | 0-1 | Opt |
| COCT_MT110200CA.Role  Business name: Payee Relationship Role Indicates whether payee is Person or Organisation Covered Party/Patient is the scoper of this role, but is not necessary in this CMET |
|---|
classCode : (x_RoleClassPayeePolicyRelationship)  Business name: Account Payee Policy Relationship Role Invoice Adjudication Results | 1 | Mand |
|
|
|
|
|---|
| COCT_MT120402CA.ObservationProblem  Business name: Diagnosis Indications Describes diagnosis-related indications Allows separation of conditions from symptoms from other forms of indication. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ProblemType)  Business name: Problem Type Identifies the type of problem described. Identifies this measurement as a type of diagnosis and is therefore mandatory. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | value : CD (ProblemValue)  Business name: A:Problem Code A coded form of the problem that is the reason for the current action. Allows cross-checking the use of a therapy against its indication. Also allows analysis of best practices, etc. This is the attribute that actually identifies the indication and is therefore mandatory. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. | 1 | Mand |
|
COCT_MT120402CA.OtherIndication  Business name: Other indications Describes indications that are not diagnosis or symptom-related (e.g. contrast agents) Allows separation of conditions from symptoms from other forms of indication. Must have at least one of code or text |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActNonConditionIndicationCode)  Business name: Other Indication A code indicating some other action which is the reason for a therapy. Allows for coded representation of a non-condition based indication such as administration of a contrast agent for a lab test. EPHS: vocab proposal needed for simple concepts of i) sign or symptom related to investigation disease ii) sign or symptom not related to investigation disease. EPHS: act.code value needed for encounter reason; reason for treatment; immunization interpretation reason | 0-1 | Req | text :  Business name: Other indication ad-hoc description A textual description of an indication not meant to be either diagnosis or symptom. Provides ability to describe indication without labeling it a diagnosis or symptom. Attribute as free form text is the only information allowed. | 0-1 | Req | statusCode : "completed" (ActStatus) | 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. Identified-confirmable is used on requests Identified-information is used on responses |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | text : ST.LANG  Business name: B: 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. Language is supported to allow grouping or filtering comments based on language | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | | 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: A: 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 | | Choice: assignedPerson : AssignedPerson | 1 | Mand | | »» Choice: actingPerson1 : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship1 : PersonalRelationship | 0-1 | Opt | | »» Choice: actingPerson2 : ActingPerson | 0-1 | Opt | | »» assignedEntity3 : AssignedEntity | 0-1 | Opt | | »» assignedEntity4 : AssignedEntity | 0-1 | Opt | | »» personalRelationship2 : PersonalRelationship | 0-1 | Opt | | »» personalRelationship4 : PersonalRelationship | 0-1 | Opt |
|
|
|
|
|---|
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 | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| 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.BUS  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.FULLDATEWITHTIME>  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 : (MedicalDeviceType)  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 '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_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 : "ADMM" (RoleClass) | 1 | Mand | | administerableMedicine : 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 : CD (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-50 | 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.PUBLIC  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 : "ADMM" (RoleClass) | 1 | Mand | | administerableMedicine : 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 : CD (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-50 | 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 '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_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 : "ADMM" (RoleClass) | 1 | Mand | | administerableMedicine : 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 : CD (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 is CD to support SNOMED CT. 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-50 | 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 | Mand |
|
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.PUBLIC  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 : "ADMM" (RoleClass) | 1 | Mand | | administerableMedicine : Medicine | 1 | Mand |
| COCT_MT220210CA.Medicine  Business name: Drug or Compound |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : CD (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 is CD to support SNOMED CT. 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-50 | 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_MT240002CA.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_MT240002CA.ServiceDeliveryLocation  Business name: Service Location An identification of a service location (or facility) that can be found in the service delivery location. 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.PUBLIC  Business name: C:Service Location Identifier 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 | | location : Place | 1 | Mand | | subjectOf : Subject | 0-5 | Opt |
|
COCT_MT240002CA.Subject  Business name: located at Identifies the position of the service delivery location according to a set of geographic coordinates. Allows capturing of GPS, legal land, and/or range-meridian coordinates of a location for subsequent proximity searching. Also allows the capture of disaster sites and other non-dedicated service delivery locations which may not have a traditional address. (These locations are typically registered for public health purposes.) The association is optional because not all systems will choose to support capturing information at this level. |
|---|
typeCode : "SBJ" (ParticipationType) | 1 | Mand | | position : Position | 1 | Pop |
|
|
|
|
|---|
| 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 Information other than the id is expected to be extracted from the service delivery location registry. 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.PUBLIC  Business name: C:Service Location Identifier 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 | code : (ServiceDeliveryLocationRoleType)  Business name: A: Service Location Type Describes the basic type or category of the service delivery location. Useful in providing context. May also be used for grouping and organizing data. Because this is a key element in understanding the location, it is mandatory. | 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 | | subjectOf : Subject | 0-5 | Opt |
|
COCT_MT240003CA.Subject  Business name: located at Identifies the position of the service delivery location according to a set of geographic coordinates. Allows capturing of GPS, legal land, and/or range-meridian coordinates of a location for subsequent proximity searching. Also allows the capture of disaster sites and other non-dedicated service delivery locations which may not have a traditional address. (These locations are typically registered for public health purposes.) The association is optional because not all systems will choose to support capturing information at this level. |
|---|
typeCode : "SBJ" (ParticipationType) | 1 | Mand | | position : Position | 1 | Pop |
|
|
|
|
|---|
| COCT_MT240007CA.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_MT240007CA.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 Also used to capture non-dedicated facilities such as "side of the road". This CMET is intended for circumstances that the desired service delivery location is not in the registry Information other than the id is expected to be extracted from the service delivery location registry. 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.PUBLIC  Business name: C:Service Location Identifier Unique identifier for a healthcare service location. Allows for a location to be uniquely referenced. However, because this CMET is used for locations not necessarily found in a registry, the attribute is only 'required'. PVD.020-01 (extension) PVD.020-02 (root) Dispensing Pharmacy number Pharmacy Identifier Facility.facilityKey DispensedItem.facilityKey | 0-1 | Req | code : (ServiceDeliveryLocationRoleType)  Business name: A: Service Location Type Describes the basic type or category of the service delivery location. Useful in providing context. May also be used for grouping and organizing data. Because this is a key element in understanding the location, it is mandatory. | 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 | | subjectOf : Subject | 0-5 | Opt |
|
COCT_MT240007CA.Subject  Business name: located at Identifies the position of the service delivery location according to a set of geographic coordinates. Allows capturing of GPS, legal land, and/or range-meridian coordinates of a location for subsequent proximity searching. Also allows the capture of disaster sites and other non-dedicated service delivery locations which may not have a traditional address. (These locations are typically registered for public health purposes.) The association is optional because not all systems will choose to support capturing information at this level. |
|---|
typeCode : "SBJ" (ParticipationType) | 1 | Mand | | position : Position | 1 | Pop |
|
|
|
|
|---|
| COCT_MT240012CA.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_MT240012CA.ServiceDeliveryLocation  Business name: Service Location An identification of a service location (or facility) that can be found in the service delivery location. 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.PUBLIC  Business name: C:Service Location Identifier 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 | | location : Place | 1 | Mand |
|
|
|
|
|---|
| COCT_MT260010CA.Author1  Business name: *managed by Identifies the provider who managed the issue. Part of the audit record and therefore mandatory. OverrideReason.provider ManagedContraindication.provider A_DetectedMedicationIssue |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME  Business name: B:Management Date The date and time on which the provider managed the issue. Part of the audit record, but not always available and therefore 'populated'. ManagedContraindication.CreationDate | 1 | Pop | | assignedEntity : AssignedEntity | 1 | Mand |
|
COCT_MT260010CA.Author2  Business name: is created by Identity of the organization who is responsible for the contents of the monograph. Provides a means of evaluating accuracy of content. ZPE.1 ZDU.5.1 Contraindication.dataSource |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | time : TS.FULLDATE  Business name: B:Issue Monograph Effective Date The date and time on which the monograph becomes valid and applicable. Allows detailed matching of local knowledgebase record with that of the central. (The monograph id may remain the same, but the effective date will always change). DDIMonograph.EffectiveDate A_DetectedMedicationIssue | 0-1 | Req | | assignedEntity : AssignedEntity | 1 | Mand |
| |
| |
COCT_MT260010CA.Consumable  Business name: related to Identification of the drug that caused the issue. Required for effective management of the issue. The association is only marked as 'required' because SNOMED can pre-coordinate drug information into code. A_DetectedMedicationIssue This must be populated (with a drug or null flavor) if not using SNOMED |
|---|
typeCode : "CSM" (ParticipationType) | 1 | Mand | | medication : Medication | 1 | Pop |
| |
COCT_MT260010CA.DetectedIssueDefinition  Business name: Issue Description This is the decision support rule that triggered the issue. Provides detailed background for providers in evaluating the issue. |
|---|
classCode : "ALRT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Issue Monograph Id Knowledgebase organization specific identifier for the issue definition. Allows applications to match with local Knowledge-bases and avoid displaying duplicate issues to providers. DDIMonograph.DDIMonographId ZPE.2 MB.05.03C ZPS.14 ZDU.5.2 A_DetectedMedicationIssue Monograph Code | 0-1 | Req | text : ED.DOCORREF  Business name: C:Issue Description A free form textual description of the issue. This is usually in the form of a monograph. Provides detailed clinical background on reasons for issue. Monograph URI (Reference) Monograph description | 0-1 | Req | | author : Author2 | 1 | Mand | | component : Component | 0-1 | Req |
| COCT_MT260010CA.DetectedIssueEvent  Business name: Issues This is the list of clinical and business issues that have been detected and recorded involving the current action. Provides a list of issues that have been detected and/or managed. |
|---|
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, 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. Contraindication.crossSensitive (if code is related reaction dected issue then crossSensitive is 'True') Distinguishes between DAI, DDI, DosageCheck, DPD, and Duplicate Therapy Contraindications Contraindication.DosageContraType OverrideReason.reasonDomain ZP3.3 E06(for contraindications errors are handled at transmission or controlAct wrapper level) 05.03D DUR Response Codes Interaction Type ZPS.7.1 ZDU.9.1(PLYPHRM) ZDU.10.1 (PLYDOC) ZDU.6.2 ZDU.6.4 ZDU.7.3 DRU.100-01 DUR/PPS.439-E4 A_DetectedMedicationIssue | 1 | Mand | text :  Business name: D:Issue Details A free form textual description of a detected issue. This textual information is provided to either augment the coded information or in place of the coded information. Lets providers see textual explanation of the issue. Contraindication.DDIDescription E20(for contraindication errors are handled at transmission or controlact wrapper level) ZPE.4 ZDU.11.1 | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | priorityCode : (ActIssuePriority)  Business name: C:Issue Priority A coded value denoting the importance of a detectable issue. Valid codes are: I - for Information, E - for Error, and W - for Warning. Allows the provider to make informed decision on the importance and criticality of an issue. May also be used by the DIS to determine the order of returning issues. Attribute is mandatory because every issue needs to be prioritized. | 1 | Mand | targetSiteCode : SET<ST>  Business name: Message Issue Location Used to identify XPath references that indicate which attributes from the message instance were involved in the issue. | 0-5 | Req | | subject : Subject2 | 0-25 | Req | | instantiation : Definition | 0-1 | Req | | mitigatedBy : Mitigates | 0-25 | Req | | subjectOf : Subject | 1 | Mand |
|
COCT_MT260010CA.DetectedIssueManagement  Business name: Issue Managements The processes and procedures employed by providers to resolve clinical and business issues between the action being performed and additional information already in the patient's record or system business rules. It allows overriding of the detected issue A_DetectedMedicationIssue |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDetectedIssueManagementCode)  Business name: A:Management Type Indicates the kinds of management actions that have been taken, depending on the issue type. Ensures consistency in description of management actions. This is mandatory so as to ensure distinction between different kinds of management. ManagedContraindication.State OverrideReason.reason D65(when dealing with clinical indication overrides, otherwise use overrides in ControlAct wrapper. ZPB3.10 Intervention Codes ZPS.8 ZPS.15 ZDP.21.1 DRU.100-02 DRU.100-03 DUR/PPS.440-E6 DUR/PPS.441-E6 Claim.420-DK A_DetectedMedicationIssue | 1 | Mand | text :  Business name: C:Management Description Additional free-text details describing the management of the issue. Allows additional clinical detail to be conveyed that are important clinically and not conveyed by the code. | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | | author : Author1 | 1 | Mand |
| COCT_MT260010CA.Location  Business name: *b:dispensed at Indicates the facility where the dispense event was performed Used for contacting the pharmacy or pharmacist involved in the dispense. The association is marked as populated because it may be masked. A_DetectedMedicationIssue |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| COCT_MT260010CA.ObservationCodedEvent  Business name: Patient Coded Observations This is the recorded observation (e.g. allergy, medical condition, lab result, pregnancy status, etc.) of the patient that contributed to the issue being raised. Useful for determining appropriate management and for drilling down for more information. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Observation Identifier Unique identifier for the record of the coded observation (e.g. allergy, medical condition, pregnancy status, etc.) that contributed to the issue. Allows lookup of the specific coded observation (e.g. allergy, medical condition, pregnancy status, etc.) for additional details when evaluating appropriateness of issue management. | 1 | Pop | code : CD (CommonCodedClinicalObservationType)  Business name: B:Observation Type Distinguishes the kinds of coded observation that could be the trigger for clinical issue detection. Coded Observation types include: Allergy, Intolerance, Medical Condition, Indication, Pregnancy status, Lactation status and other observable information about a person that may be deemed as a possible trigger for clinical issue detection. Indicates the type of recorded observation being referenced. The attribute is mandatory because it is essential to interpreting the rest of the information on the class. Differentiates DAI from DPD Contraindications DRU.100-04 (mnemonic) DRU.100-05 (code system) | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: D:Observation Masking Indicator An indication of sensitivity surrounding the related condition, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the observation information. The attribute is optional because not all systems will support masking. Contraindication.intractingSourceMasked (Normal=false; Restricted or Very Restricted = True); (Information is withheld because the prescription is masked will be given a NULL flavour of 'Masked') | 0-2 | Opt | value : (IssueTriggerObservationValue)  Business name: C:Observation Value Denotes a specific coded observation made about a person that might have trigger the clinical issue detection. Provides unambiguous reference to the related coded observation. Containdication.allergenGroupName (PrintName) PIN:Contraindications.drugAllergy (Inferred from Code System - if it is a DIN it is probably a drug) Contraindication.indicationDescription ZDU.7.1 (Code System) ZDU.7.2 (mnemonic) ZDU.8.2 (Code System) ZDU.8.3 (mnemonic) ZDU.8.1 (Print Name) Disease Code | 0-1 | Req |
|
COCT_MT260010CA.ObservationEventCriterion  Business name: Dosage Preconditions A condition that must be true for the patient in order for the specified recommended dosage range to apply. Allows recommended dosage instructions to be bound to a particular characteristic of the patient. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | code : (ObservationDosageDefinitionPreconditionType)  Business name: A:Dosage Precondition Type Indicates the type of characteristic against which the patient is evaluated. This includes age, weight, height, etc. Allows the specification of multiple preconditions for a dosage specification, such as Age Range, Weight Range, etc. This is mandatory because the precondition range cannot be evaluated without knowing the precondition type. | 1 | Mand | value : URG<PQ.BASIC>  Business name: B:Dosage Precondition Value A specific value or range of values of the Dosage Precondition Type, for which the recommended dosage applies. This includes min-max age range, min-max weights, etc. This is a mandatory attribute as the values of the measurements must be known. If not specified, it means that the range is based on a criteria (e.g. weight), but the specific range on which the criteria is based is not known. Allows direct comparison of the patient's characteristics with the minimum and maximum values specified. The element is mandatory because there's no point in identifying that the dosage range is based on criteria unless the specific criterion used is expressed. Minimum Age Maximum Age | 1 | Mand |
| COCT_MT260010CA.ObservationMeasurableEvent  Business name: Patient Measurable Observations This is the recorded observation (e.g. height, weight, lab result, etc.) of the patient that contributed to the issue being raised. Useful for determining appropriate management and for drilling down for more information. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Observation Identifier Unique identifier for the record of the observation (e.g. height, weight or lab test/result) that contributed to the issue. Allows lookup of the specific observation (e.g. height, weight, or lab record) for additional details when evaluating appropriateness of issue management. | 1 | Pop | code : CD (SimpleMeasurableClinicalObservationType)  Business name: B:Observation Type Distinguishes between the kinds of measurable observation that could be the trigger for clinical issue detection. Measurable observation types include: Lab Result, Height, Weight, and other measurable information about a person that may be deemed as a possible trigger for clinical issue detection. Indicates the type of observation record being referenced. The attribute is mandatory because it is essential to interpreting the rest of the information on the class. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: D:Observation Masking Indicator An indication of sensitivity surrounding the related measurable observation, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the observation information. The attribute is optional because not all systems will support masking. Contraindication.intractingSourceMasked (Normal=false; Restricted or Very Restricted = True); (Information is withheld because the prescription is masked will be given a NULL flavour of 'Masked') | 0-2 | Opt | value : PQ.BASIC  Business name: C:Observation Value Denotes a specific measurable observation made about a person that might have trigger the clinical issue detection. Provides unambiguous reference to the related measurable observation. | 0-1 | Req |
|
| COCT_MT260010CA.Product  Business name: *a:dispensed Indicates the drug that was dispensed Important information for issue management. The association is marked as populated because it may be masked. |
|---|
typeCode : "PRD" (ParticipationType) | 1 | Mand | | medication : Medication | 1 | Pop |
|
COCT_MT260010CA.SeverityObservation  Business name: Severity Level This is a ranking/assertion of gravity of the detected issue. Suggests the importance of managing the issue. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : "SEV" (ActCode)  A coded value denoting a category of severity used for the detected issue. Allows for different severity code systems to be employed in assigning severity. A_DetectedMedicationIssue | 1 | Mand | value : (SeverityObservation)  Business name: B:Severity Code A coded value denoting the gravity of the detected issue. May be used to determine which contraindications must be managed and how. This attribute is marked as "mandatory" because the code denoting the level of severity must be specified. Contraindication.severity ZPE.3 MB.05.03A Severity ZDU.6.3 ZDU.8.4 A_DetectedMedicationIssue | 1 | Mand |
| |
| COCT_MT260010CA.SubstanceAdministration  Business name: Active Medication Indicates an active medication (prescription or non-prescription medication) that is recorded in the patients record and which contributed to triggering the issue. Allows providers to identify the offending drugs when determining their management approach. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : (x_ActMoodRequestEvent)  Business name: Other Medication Indicator If the attribute is 'RQO', represents a prescription or dispense record. Otherwise if 'EVN', it represents an 'Other Medication' record. Knowing whether a drug is prescribed or not can influence actions taken to mitigate an issue. This attribute is therefore mandatory. | 1 | Mand | id : II.BUS  Business name: A:Active Medication Record Number Unique identifier of the prescription or other medication drug record that triggered the issue. Allows provider to drill-down and retrieve additional information about the implicated drug therapy to either modify the therapy or to learn more information in determining their management approach for the issue. DDI/DuplicateTherapy.InteractingPrescriptionNumber InteractingPrescription.PrescriptionExternalKey InteractingPrescription.PrescriptionNumber DDI/Dosage/Duplicate Therapy.SourceNumber (All senders must uniquely identify prescriptions on request) | 1 | Pop | code : CD (ActSubstanceAdministrationCode)  Business name: Administration Type Identifies whether the interaction is with a drug or a vaccine. For SNOMED, may also indicate the specific drug or vaccine at issue. Needed to determine what to do about the issue. Because the medication can be masked, this element is only marked as 'populated'. The element allows a full 'CD' type to support SNOMED implementations. | 1 | Pop | statusCode : (ActStatus)  Business name: B:Active Medication Status Indicates the status of the medication record at the time of the issue. Used to determine the relevance of the issue and the need to manage it. For example, if the medication is on hold, it may be less of an issue than if it is being actively taken. ZPB3.8 (aborted = discontinued; nullified = reversed/system reversed; active=filled/not-filled) | 0-1 | Req | effectiveTime : IVL<TS.FULLDATE>  Business name: C:Active Medication Time-range The date and time during which the patient is expected to be taking the drug which triggered the issue. Allows the provider to evaluate duplicate therapy and similar timing-based issues. Requested Duration | 0-1 | Req | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: E:Active Medication Masking Indicator An indication of sensitivity surrounding the related drug, and thus defines the required sensitivity for the detected issue. Conveys the patients wishes relating to the sensitivity of the drug information. The attribute is optional because not all systems will support masking. | 0-2 | Opt | doseQuantity : PQ.DRUG  Business name: D:Active Medication Dose Quantity The amount of medication administered to the patient Used in Low Dose/High Dose issues. Requested Dosage Level ZPS.12 ZDU.4.4 Contraindication.dosageAmount | 0-1 | Req | | consumable : Consumable | 0-1 | Req |
|
COCT_MT260010CA.SubstanceAdministrationEventCriterion  Business name: Recommended Dosage Identifies the outer dosage boundaries that were exceeded and triggered the issue. Included in this information are the drug-specific recommended dosage ranges for various age groups and weight classes. Provides a reference for calculating optimum dose of medication for patients. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | effectiveTime : IVL.WIDTH<TS.FULLDATE>  Business name: A:Dose Duration Indicates the recommended duration for drug therapy that was exceeded or not met. Allows calculation of amount under or over. Recommended Duration (width) | 0-1 | Req | doseQuantity : URG<PQ.DRUG>  Business name: B:Dosage Range This is a specification of the range of quantity of medication (Min/Max figures) that is recommended for the drug to avoid triggering of dosage issues. Allows calculation of amount over/under. ContraIndication.recommendedRange Maximum Dosage Level (high) Minimum Dosage Level (low) | 0-1 | Req | | component : Component2 | 0-3 | Req |
| COCT_MT260010CA.SupplyEvent  Business name: Dispense Indicates a particular dispense event that resulted in the issue. Used when the issue pertains to the supply of the drug rather than the drug itself. E.g. Duplicate pharmacy, refill too soon, etc. |
|---|
classCode : "SPLY" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Prescription Dispense Number Unique identifier of the dispensed event that triggered the issue. Allows provider to drill down and retrieve additional information about the dispense event for consideration in their issue management decision. | 1 | Pop | statusCode : (ActStatus)  Business name: B: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 | effectiveTime : IVL.HIGH<TS.FULLDATE>  Business name: B:Dispensed Date The date and time on which the product was issued to the patient. Applications should specify a null flavor of "Not Applicable" for dispenses that have not yet been picked up. Allows evaluation of 'refill too soon' and similar issues. Attribute is marked as 'populated' as a dispense record may not exist without processing date. ZDU.4.5 | 1 | Pop | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: C:Dispense Masking Indicator An indication of sensitivity surrounding the related drug, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the drug information. The attribute is optional because not all systems will support masking. | 0-2 | Opt | | product : Product | 1 | Pop | | location : Location | 1 | Pop |
|
|
|
|
|---|
COCT_MT260012CA.Author1  Business name: *managed by Identifies the provider who managed the issue. Part of the audit record and therefore mandatory. OverrideReason.provider ManagedContraindication.provider A_DetectedMedicationIssue |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME  Business name: B:Management Date The date and time on which the provider managed the issue. Part of the audit record, but not always available and therefore 'populated'. ManagedContraindication.CreationDate | 1 | Pop | | assignedEntity : AssignedEntity | 1 | Mand |
| COCT_MT260012CA.DetectedIssueEvent  Business name: Issues This is the list of clinical and business issues that have been detected and recorded involving the current action. Provides a list of issues that have been detected and/or managed. |
|---|
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, 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. Contraindication.crossSensitive (if code is related reaction dected issue then crossSensitive is 'True') Distinguishes between DAI, DDI, DosageCheck, DPD, and Duplicate Therapy Contraindications Contraindication.DosageContraType OverrideReason.reasonDomain ZP3.3 E06(for contraindications errors are handled at transmission or controlAct wrapper level) 05.03D DUR Response Codes Interaction Type ZPS.7.1 ZDU.9.1(PLYPHRM) ZDU.10.1 (PLYDOC) ZDU.6.2 ZDU.6.4 ZDU.7.3 DRU.100-01 DUR/PPS.439-E4 A_DetectedMedicationIssue | 1 | Mand | text :  Business name: D:Issue Details A free form textual description of a detected issue. This textual information is provided to either augment the coded information or in place of the coded information. Lets providers see textual explanation of the issue. Contraindication.DDIDescription E20(for contraindication errors are handled at transmission or controlact wrapper level) ZPE.4 ZDU.11.1 | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | priorityCode : (ActIssuePriority)  Business name: C:Issue Priority A coded value denoting the importance of a detectable issue. Valid codes are: I - for Information, E - for Error, and W - for Warning. Allows the provider to make informed decision on the importance and criticality of an issue. May also be used by the DIS to determine the order of returning issues. Attribute is mandatory because every issue needs to be prioritized. | 1 | Mand | targetSiteCode : SET<ST>  Business name: Message Issue Location Used to identify XPath references that indicate which attributes from the message instance were involved in the issue. | 0-5 | Req | | mitigatedBy : Mitigates | 0-25 | Req |
|
COCT_MT260012CA.DetectedIssueManagement  Business name: Issue Managements The processes and procedures employed by providers to resolve clinical and business issues between the action being performed and additional information already in the patient's record or system business rules. It allows overriding of the detected issue A_DetectedMedicationIssue |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDetectedIssueManagementCode)  Business name: A:Management Type Indicates the kinds of management actions that have been taken, depending on the issue type. Ensures consistency in description of management actions. This is mandatory so as to ensure distinction between different kinds of management. ManagedContraindication.State OverrideReason.reason D65(when dealing with clinical indication overrides, otherwise use overrides in ControlAct wrapper. ZPB3.10 Intervention Codes ZPS.8 ZPS.15 ZDP.21.1 DRU.100-02 DRU.100-03 DUR/PPS.440-E6 DUR/PPS.441-E6 Claim.420-DK A_DetectedMedicationIssue | 1 | Mand | text :  Business name: C:Management Description Additional free-text details describing the management of the issue. Allows additional clinical detail to be conveyed that are important clinically and not conveyed by the code. | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | | author : Author1 | 1 | Mand |
| |
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
|
|---|
| COCT_MT260022CA.Author1  Business name: managed by Identifies the provider who created the management of the issue. Part of the audit record, but may not always be known for historical managements. OverrideReason.provider ManagedContraindication.provider A_DetectedMedicationIssue |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME  Business name: B:Management Date The date and time on which the provider used this management for the issue in the past. Part of the audit record but not always available and therefore only marked as 'populated'. ManagedContraindication.CreationDate | 1 | Pop | | assignedEntity : AssignedEntity | 1 | Pop |
|
COCT_MT260022CA.DetectedIssueEvent  Business name: Issues This is the list of clinical and business-rule issues that have been detected and recorded involving the current action. Provides a list of issues that have been detected. |
|---|
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, etc. Identifies what kind of issue was detected. This is mandatory so as to ensure that one issue type can be distinguished from another. Contraindication.crossSensitive (if code is related reaction dected issue then crossSensitive is 'True') Distinguishes between DAI, DDI, DosageCheck, DPD, and Duplicate Therapy Contraindications Contraindication.DosageContraType OverrideReason.reasonDomain ZP3.3 E06(for contraindications errors are handled at transmission or controlAct wrapper level) 05.03D DUR Response Codes Interaction Type ZPS.7.1 ZDU.9.1(PLYPHRM) ZDU.10.1 (PLYDOC) ZDU.6.2 ZDU.6.4 ZDU.7.3 DRU.100-01 DUR/PPS.439-E4 A_DetectedMedicationIssue | 1 | Mand | text :  Business name: D:Issue Details A free form textual description of a detected issue. This textual information is provided to either augment the coded information or in place of the coded information. Lets providers see textual explanation of the issue. Contraindication.DDIDescription E20(for contraindication errors are handled at transmission or controlact wrapper level) ZPE.4 ZDU.11.1 | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | priorityCode : (ActIssuePriority)  Business name: C:Issue Priority A coded value denoting the importance of a detectable issue. Valid codes are: I - for Information, E - for Error, and W - for Warning. Allows the provider to make informed decision on the importance and criticality of an issue. May also be used by the DIS to determine the order of returning issues. Attribute is mandatory because every issue needs to be prioritized. | 1 | Mand | targetSiteCode : SET<ST>  Business name: Message Issue Location Used to identify XPath referencesthat indicate which attributes in a message instance were involved in the issue. | 0-5 | Req | | mitigatedBy : Mitigates | 0-25 | Req | | triggerFor : Trigger2 | 0-1 | Req |
| COCT_MT260022CA.DetectedIssueManagement  Business name: Issue Managements The processes and procedures employed by providers to resolve clinical conflicts between the action being performed and additional information already in the patient's record. Presents alternatives for how the issue could be managed or has been managed in the past. A_DetectedMedicationIssue |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | code : (ActDetectedIssueManagementCode)  Business name: A:Management Type Indicates the kinds of management actions that can be taken, based on the issue type. Ensures consistency in description of management actions. This is mandatory so as to ensure distinction between different kinds of management. ManagedContraindication.State OverrideReason.reason D65(when dealing with clinical indication overrides, otherwise use overrides in ControlAct wrapper. ZPB3.10 Intervention Codes ZPS.8 ZPS.15 ZDP.21.1 DRU.100-02 DRU.100-03 DUR/PPS.440-E6 DUR/PPS.441-E6 Claim.420-DK A_DetectedMedicationIssue | 1 | Mand | text :  Business name: C:Management Description Additional free-text details describing the management of the issue. Allows additional clinical detail to be conveyed that are important clinically and not conveyed by the code. | 0-1 | Req | | author : Author1 | 0-1 | Req |
|
| |
|
|
|
|---|
| COCT_MT260030CA.Author1  Business name: *managed by Identifies the provider who managed the issue. Part of the audit record and therefore mandatory. OverrideReason.provider ManagedContraindication.provider A_DetectedMedicationIssue |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | time : TS.FULLDATETIME  Business name: B:Management Date The date and time on which the provider managed the issue. Part of the audit record, but not always available and therefore 'populated'. ManagedContraindication.CreationDate | 1 | Pop | | assignedEntity : AssignedEntity | 1 | Mand |
|
COCT_MT260030CA.Author2  Business name: is created by Identity of the organization who is responsible for the contents of the monograph. Provides a means of evaluating accuracy of content. ZPE.1 ZDU.5.1 Contraindication.dataSource |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : TS.FULLDATE  Business name: B:Issue Monograph Effective Date The date and time on which the monograph becomes valid and applicable. Allows detailed matching of local knowledgebase record with that of the central. (The monograph id may remain the same, but the effective date will always change). DDIMonograph.EffectiveDate A_DetectedMedicationIssue | 0-1 | Req | | assignedEntity : AssignedEntity | 1 | Mand |
| |
| |
COCT_MT260030CA.Consumable  Business name: related to Identification of the drug that caused the issue. Required for effective management of the issue. Because SNOMED can pre-coordinate drug into code, this element is only 'required'. A_DetectedMedicationIssue This must be populated (with a drug or null flavor) if not using SNOMED |
|---|
typeCode : "CSM" (ParticipationType) | 1 | Mand | | medication : Medication | 1 | Pop |
| |
COCT_MT260030CA.DetectedIssueDefinition  Business name: Issue Description This is the decision support rule that triggered the issue. Provides detailed background for providers in evaluating the issue. |
|---|
classCode : "ALRT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Issue Monograph Id Knowledgebase organization specific identifier for the issue definition. Allows applications to match with local Knowledge-bases and avoid displaying duplicate issues to providers. DDIMonograph.DDIMonographId ZPE.2 MB.05.03C ZPS.14 ZDU.5.2 A_DetectedMedicationIssue Monograph Code | 0-1 | Req | text : ED.DOCORREF  Business name: C:Issue Description A free form textual description of the issue. This is usually in the form of a monograph. Provides detailed clinical background on reasons for issue. Monograph URI (Reference) Monograph description | 0-1 | Req | | author : Author2 | 1 | Mand | | component : Component | 0-1 | Req |
| COCT_MT260030CA.DetectedIssueEvent  Business name: Issues This is the list of clinical and business issues that have been detected and recorded involving the current action. Provides a list of issues that have been detected and/or managed. |
|---|
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. Contraindication.crossSensitive (if code is related reaction dected issue then crossSensitive is 'True') Distinguishes between DAI, DDI, DosageCheck, DPD, and Duplicate Therapy Contraindications Contraindication.DosageContraType OverrideReason.reasonDomain ZP3.3 E06(for contraindications errors are handled at transmission or controlAct wrapper level) 05.03D DUR Response Codes Interaction Type ZPS.7.1 ZDU.9.1(PLYPHRM) ZDU.10.1 (PLYDOC) ZDU.6.2 ZDU.6.4 ZDU.7.3 DRU.100-01 DUR/PPS.439-E4 A_DetectedMedicationIssue | 1 | Mand | text :  Business name: D:Issue Details A free form textual description of a detected issue. This textual information is provided to either augment the coded information or in place of the coded information. Lets providers see textual explanation of the issue. Contraindication.DDIDescription E20(for contraindication errors are handled at transmission or controlact wrapper level) ZPE.4 ZDU.11.1 | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | priorityCode : (ActIssuePriority)  Business name: C:Issue Priority A coded value denoting the importance of a detectable issue. Valid codes are: I - for Information, E - for Error, and W - for Warning. Allows the provider to make informed decision on the importance and criticality of an issue. May also be used by the DIS to determine the order of returning issues. Attribute is mandatory because every issue needs to be prioritized. | 1 | Mand | targetSiteCode : SET<ST>  Business name: Message Issue Location Used to identify XPath references that indicate which attributes in a message instance were involved in the issue. | 0-5 | Req | | subject : Subject2 | 0-25 | Req | | instantiation : Definition | 0-1 | Req | | mitigatedBy : Mitigates | 0-25 | Req | | subjectOf : Subject | 1 | Mand |
|
COCT_MT260030CA.DetectedIssueManagement  Business name: Issue Managements The processes and procedures employed by providers to resolve clinical and business issues between the action being performed and additional information already in the patient's record or system business rules. It allows overriding of the detected issue A_DetectedMedicationIssue |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDetectedIssueManagementCode)  Business name: A:Management Type Indicates the kinds of management actions that have been taken, depending on the issue type. Ensures consistency in description of management actions. This is mandatory so as to ensure distinction between different kinds of management. ManagedContraindication.State OverrideReason.reason D65(when dealing with clinical indication overrides, otherwise use overrides in ControlAct wrapper. ZPB3.10 Intervention Codes ZPS.8 ZPS.15 ZDP.21.1 DRU.100-02 DRU.100-03 DUR/PPS.440-E6 DUR/PPS.441-E6 Claim.420-DK A_DetectedMedicationIssue | 1 | Mand | text :  Business name: C:Management Description Additional free-text details describing the management of the issue. Allows additional clinical detail to be conveyed that are important clinically and not conveyed by the code. | 0-1 | Req | statusCode : "completed" (ActStatus) | 1 | Mand | | author : Author1 | 1 | Mand |
| COCT_MT260030CA.Location  Business name: *b:dispensed at Indicates the facility where the dispense event was performed Used for contacting the pharmacy or pharmacist involved in the dispense. The association is marked as populated because it may be masked. A_DetectedMedicationIssue |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| COCT_MT260030CA.ObservationCodedEvent  Business name: Patient Coded Observations This is the recorded observation (e.g. allergy, medical condition, lab result, pregnancy status, etc.) of the patient that contributed to the issue being raised. Useful for determining appropriate management and for drilling down for more information. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Observation Identifier Unique identifier for the record of the coded observation (e.g. allergy, medical condition, pregnancy status, etc.) that contributed to the issue. Allows lookup of the specific coded observation (e.g. allergy, medical condition, pregnancy status, etc.) for additional details when evaluating appropriateness of issue management. | 1 | Pop | code : CD (CommonCodedClinicalObservationType)  Business name: B:Observation Type Distinguishes the kinds of coded observation that could be the trigger for clinical issue detection. Coded Observation types include: Allergy, Intolerance, Medical Condition, Indication, Pregnancy status, Lactation status and other observable information about a person that may be deemed as a possible trigger for clinical issue detection. Indicates the type of recorded observation being referenced. The attribute is mandatory because it is essential to interpreting the rest of the information on the class. Differentiates DAI from DPD Contraindications DRU.100-04 (mnemonic) DRU.100-05 (code system) | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: D:Observation Masking Indicator An indication of sensitivity surrounding the related condition, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the observation information. The attribute is optional because not all systems will support masking. Contraindication.intractingSourceMasked (Normal=false; Restricted or Very Restricted = True); (Information is withheld because the prescription is masked will be given a NULL flavour of 'Masked') | 0-2 | Opt | value : (IssueTriggerObservationValue)  Business name: C:Observation Value Denotes a specific coded observation made about a person that might have trigger the clinical issue detection. Provides unambiguous reference to the related coded observation. Containdication.allergenGroupName (PrintName) PIN:Contraindications.drugAllergy (Inferred from Code System - if it is a DIN it is probably a drug) Contraindication.indicationDescription ZDU.7.1 (Code System) ZDU.7.2 (mnemonic) ZDU.8.2 (Code System) ZDU.8.3 (mnemonic) ZDU.8.1 (Print Name) Disease Code | 0-1 | Req |
|
COCT_MT260030CA.ObservationEventCriterion  Business name: Dosage Preconditions A condition that must be true for the patient in order for the specified recommended dosage range to apply. Allows recommended dosage instructions to be bound to a particular characteristic of the patient. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | code : (ObservationDosageDefinitionPreconditionType)  Business name: A:Dosage Precondition Type Indicates the type of characteristic against which the patient is evaluated. This includes age, weight, height, etc. Allows the specification of multiple preconditions for a dosage specification, such as Age Range, Weight Range, etc. This is mandatory because the precondition range cannot be evaluated without knowing the precondition type. | 1 | Mand | value : URG<PQ.BASIC>  Business name: B:Dosage Precondition Value A specific value or range of values of the Dosage Precondition Type, for which the recommended dosage applies. This includes min-max age range, min-max weights, etc. This is a mandatory attribute as the specific range of values must be known. If not specified, it means that the range is based on a criteria (e.g. weight), but the specific range on which the criteria is based is not known. Allows direct comparison of the patient's characteristics with the minimum and maximum values specified. The element is mandatory because there's no point in identifying that the dosage range is based on criteria unless the specific criterion used is expressed. Minimum Age Maximum Age | 1 | Mand |
| COCT_MT260030CA.ObservationMeasurableEvent  Business name: Patient Measurable Observations This is the recorded observation (e.g. height, weight, lab result, etc.) of the patient that contributed to the issue being raised. Useful for determining appropriate management and for drilling down for more information. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Observation Identifier Unique identifier for the record of the observation (e.g. height, weight or lab test/result) that contributed to the issue. Allows lookup of the specific observation (e.g. height, weight, or lab record) for additional details when evaluating appropriateness of issue management. | 1 | Pop | code : CD (SimpleMeasurableClinicalObservationType)  Business name: B:Observation Type Distinguishes between the kinds of measurable observation that could be the trigger for clinical issue detection. Measurable observation types include: Lab Result, Height, Weight, and other measurable information about a person that may be deemed as a possible trigger for clinical issue detection. Indicates the type of observation record being referenced. The attribute is mandatory because it is essential to interpreting the rest of the information on the class. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: D:Observation Masking Indicator An indication of sensitivity surrounding the related measurable observation, and thus defines the required sensitivity for the detected issue. Conveys the patients wishes relating to the sensitivity of the observation information. The attribute is optional because not all systems will support masking. Contraindication.intractingSourceMasked (Normal=false; Restricted or Very Restricted = True); (Information is withheld because the prescription is masked will be given a NULL flavour of 'Masked') | 0-2 | Opt | value : PQ.BASIC  Business name: C:Observation Value Denotes a specific measurable observation made about a person that might have trigger the clinical issue detection. Provides unambiguous reference to the related measurable observation. | 0-1 | Req |
|
| COCT_MT260030CA.Product  Business name: *a:dispensed Indicates the drug that was dispensed Important information for issue management. The association is marked as populated because it may be masked. |
|---|
typeCode : "PRD" (ParticipationType) | 1 | Mand | | medication : Medication | 1 | Pop |
|
COCT_MT260030CA.SeverityObservation  Business name: Severity Level This is a ranking/assertion of gravity of the detected issue. Suggests the importance of managing the issue. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : "SEV" (ActCode)  A coded value denoting a category of severity used for the detected issue. Allows for different severity code systems to be employed in assigning severity. A_DetectedMedicationIssue | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | value : (SeverityObservation)  Business name: B:Severity Code A coded value denoting the gravity of the detected issue. May be used to determine which contraindications must be managed and how. This attribute is marked as "mandatory" because the code denoting the level of severity must be specified. Contraindication.severity ZPE.3 MB.05.03A Severity ZDU.6.3 ZDU.8.4 A_DetectedMedicationIssue | 1 | Mand |
| |
| COCT_MT260030CA.SubstanceAdministration  Business name: Active Medication Indicates an active medication (prescription or non-prescription medication) that is recorded in the patient's record and which contributed to triggering the issue. Allows providers to identify the offending drugs when determining their management approach. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : (x_ActMoodRequestEvent)  Business name: Other Medication Indicator If the attribute is 'RQO', represents a prescription or dispense record. Otherwise if 'EVN', it represents an 'Other Medication' record. Knowing whether a drug is prescribed or not can influence actions taken to mitigate an issue. The element is therefore mandatory | 1 | Mand | id : II.BUS  Business name: A:Active Medication Record Number Unique identifier of the prescription or other medication drug record that triggered the issue. Allows provider to drill-down and retrieve additional information about the implicated drug therapy to either modify the therapy or to learn more information in determining their management approach for the issue. DDI/DuplicateTherapy.InteractingPrescriptionNumber InteractingPrescription.PrescriptionExternalKey InteractingPrescription.PrescriptionNumber DDI/Dosage/Duplicate Therapy.SourceNumber (All senders must uniquely identify prescriptions on request) | 1 | Pop | code : CD (ActSubstanceAdministrationCode)  Business name: Administration Type Identifies whether the interaction is with a drug or a vaccine. For SNOMED, may also indicate the specific drug or vaccine at issue. Needed to determine what to do about the issue. Because the medication can be masked, this element is only marked as 'populated'. The element allows a full 'CD' type to support SNOMED implementations. | 1 | Pop | statusCode : (ActStatus)  Business name: B:Active Medication Status Indicates the status of the medication record at the time of the issue. Used to determine the relevance of the issue and the need to manage it. For example, if the medication is on hold, it may be less of an issue than if it is being actively taken. ZPB3.8 (aborted = discontinued; nullified = reversed/system reversed; active=filled/not-filled) | 0-1 | Req | effectiveTime : IVL<TS.FULLDATE>  Business name: C:Active Medication Time-range The date and time during which the patient is expected to be taking the drug which triggered the issue. Allows the provider to evaluate 'duplicate therapy' and similar timing-based issues. Requested Duration | 0-1 | Req | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: E:Active Medication Masking Indicator An indication of sensitivity surrounding the related drug, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the drug information. The attribute is optional because not all systems will support masking. | 0-2 | Opt | doseQuantity : PQ.DRUG  Business name: D:Active Medication Dose Quantity The amount of medication administered to the patient Used in Low Dose/High Dose issues. Requested Dosage Level ZPS.12 ZDU.4.4 Contraindication.dosageAmount | 0-1 | Req | | consumable : Consumable | 0-1 | Req |
|
COCT_MT260030CA.SubstanceAdministrationEventCriterion  Business name: Recommended Dosage Identifies the outer dosage boundaries that were exceeded and triggered the issue. Included in this information are the drug-specific recommended dosage ranges for various age groups and weight classes. Provides a reference for calculating optimum dose of medication for patients. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | effectiveTime : IVL.WIDTH<TS.FULLDATE>  Business name: A:Dose Duration Indicates the recommended duration for drug therapy that was exceeded or not met. Allows calculation of amount under or over. Recommended Duration (width) | 0-1 | Req | doseQuantity : URG<PQ.DRUG>  Business name: B:Dosage Range This is a specification of the range of quantity of medication (Min/Max figures) that is recommended for the drug to avoid triggering of dosage issues. Allows calculation of amount over/under. ContraIndication.recommendedRange Maximum Dosage Level (high) Minimum Dosage Level (low) | 0-1 | Req | | component : Component2 | 0-3 | Req |
| COCT_MT260030CA.SupplyEvent  Business name: Dispense Indicates a particular dispense event that resulted in the issue. Used when the issue pertains to the supply of the drug rather than the drug itself. E.g. Duplicate pharmacy, refill too soon, etc. |
|---|
classCode : "SPLY" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Prescription Dispense Number Unique identifier of the dispensed event that triggered the issue. Allows provider to drill down and retrieve additional information about the dispense event for consideration in their issue management decision. | 1 | Pop | statusCode : (ActStatus)  Business name: B: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 | effectiveTime : IVL.HIGH<TS.FULLDATE>  Business name: B:Dispensed Date The date and time on which the product was issued to the patient. Applications should specify a null flavor of "Not Applicable" for dispenses that have not yet been picked up. Allows evaluation of 'refill too soon' and similar issues. Attribute is marked as "populated" as a dispense record may not exist without processing date. ZDU.4.5 | 1 | Pop | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: C:Dispense Masking Indicator An indication of sensitivity surrounding the related drug, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the drug information. The attribute is optional because not all systems will support masking. | 0-2 | Opt | | product : Product | 1 | Pop | | location : Location | 1 | Pop |
|
|
|
|
|---|
COCT_MT270010CA.ActEventCriterion  Business name: Administration Precondition This sets the conditions for which a specific administration of the drug may be undertaken. Example: if headache persists for 2hrs or more 'take 2 tabs. To flag a prescription as PRN without specifying a condition, include the association but specify a null flavor for the Dosage Condition. Indicates that prescription is a 'PRN' (as needed) prescription and that doses to be consumed cannot be accurately calculated. This has important compliance implications. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN.CRT" (ActMood) | 1 | Mand | text :  Business name: A:Dosage Condition A free-form textual description of condition that must be met before the product may be administered to/by the patient. Example: When pressure exceeds 150/90 - Take 2 tabs Allows un-coded specifications of conditions in which the medication should be taken. RepeatPattern.prn (true when present) ZDP.13.6 (true when present) ZDP.13.7 | 1 | Mand |
| |
COCT_MT270010CA.Component17  Business name: b:consists of Dosage instructions may be given as textual information (as in Ad-hoc Dosage Instructions specified above) or as a structured set of dosage lines. This association allows for the specification of structured dosage lines. Structured dosage lines facilitate the checking of dosage appropriateness. It also allows for the formal calculation of days supply based on administration instructions and supplied quantity. |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | sequenceNumber : INT.POS  Business name: A:Dosage Line Order Indicates the order in which dosage lines should be performed. Ensures that each step of multiple and complex SIGs (e.g ramp up/down) is in the desired order. Dosage lines with the same sequence number should be performed in parallel. E.g. 2 tabs tid for 3 days (sequence 1) and then 1 tab tid for 4 days (sequence 2) E.g. 1 tab in the morning (sequence 1) and 2 tabs at bedtime (sequence 1) Need examples to illustrate use of sequence lines with 'ANDs' and 'THENs'. Clearly expresses the order of each dosage line to ensure the correct dosage is given. Element is mandatory to ensure that dosage lines are specified and followed in the order intended. ZDP.13.10 | 1 | Mand | | dosageLine : DosageLine | 1 | Pop |
| |
COCT_MT270010CA.Consumable1  Business name: *a:administers package component Identification of drug product that the instruction pertains to. The drug only needs to be specified if the administration instruction corresponds to one part of the overall product. For example, referring to the administration of a particular product from a combo-pack Allows the provider to have different instructions for different medications (in a package) within an overall therapy. For example, the dispensed drug could be Didrocal, and there will be a separate dosage instruction for each of the two drugs in the package. May also be used for Duo-Packs (e.g. vaginal products consisting of an ovule and a cream). CMET selected must be 'response' for query responses, non-response otherwise. Must use 'administrable' when capturing dispenses, 'orderable' otherwise |
|---|
typeCode : "CSM" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | Choice: medication1 : Medication | 1 | Pop | | »» medication1 : Medication | 0-1 | Opt | | »» medication2 : Medication | 0-1 | Opt | | »» medication3 : Medication | 0-1 | Opt | | »» medication4 : Medication | 0-1 | Opt |
| COCT_MT270010CA.DosageInstruction  Business name: Administration Instructions This comprises all specifications necessary for the dispensed product to be administered to/by the patient in a manner as intended by the prescriber. Allows providers to communicate intentions and to cross-check intended and actual methods of administration. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : (x_ActMoodDefEvnRqo)  Business name: Dosage Usage Context Indicates the context of the administration. moodCode = RQO, for administration instruction on orders moodCode = EVN, for administration instruction on dispenses moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs). Puts the class in context, and is therefore mandatory. - moodCode must be DEFN for drug definitions (such as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications | 1 | Mand | code : CD (SubstanceAdministrationType)  Business name: Dosage Type Distinguishes types of dosage. For SNOMED this will pre-coordinate route, body site and potentially drug. For non-SNOMED, this will be a fixed value of DRUG. Distinguishes between types of dosage administration and is therefore mandatory. Datatype is CD to allow for SNOMED codes. | 1 | Mand | text :  Business name: C:Rendered Dosage Instruction A free form textual specification generated from the input specifications as created by the provider. This is made up of either an 'Ad-hoc dosage instruction' or 'Textual rendition of the structured dosage lines', plus route, dosage unit, and other pertinent administration information specified by the provider. Allows the provider to verify the codified structured dosage information entered and ensure that the exploded instruction is consistent with the intended instructions. Also useful in bringing back administration instructions on query responses. This is mandatory as dosage instructions must always be available in rendered form. | 1 | Mand | effectiveTime : IVL<TS.FULLDATE>  Business name: A:Administration Period The time period (begin and end dates) within which the dispensed medication is to be completely administered to/by the patient. May differ from date prescription was issued. Frequently only the duration (width) component is specified. E.g. 100mg tid for 10 days. In that case, the start date is presumed to be the date the prescription was written Indicates the overall time boundaries in which the person is expected to take the drug. Denotes the reference point for calculating expected exhaustion date and quantity on hand. Facilitates compliance checking. Note: TID may be interpreted differently based on situation (e.g. based on schedules of a facility). Prescription.Admin istrationStartDate (Low) Prescription.Admin istrationStopDate (High) DispensedItem.expectedStartDate | 0-1 | Req | approachSiteCode : SET<CV> (HumanSubstanceAdministrationSite)  Business name: Administration Sites A value denoting the body area where the medicine should be administered. E.g. 'Right Elbow', 'Left Ear'. When multiples sites are specified they should be treated as 'AND'. Allows specificity when a drug can potentially be applied to different parts of the patien's body. Multiple repetitions are used when the product should be administered to multiple parts of the body. CWE is used because using a code system is not essential for understanding or analyzing the prescription. The attribute is optional because it can be pre-coordinated with SubstanceAdministration.code when using SNOMED. | 0-5 | Opt | routeCode : (RouteOfAdministration)  Business name: A:Route Code This is the means by which the dispensed drug is to be administered to the patient. Ensures consistency in description of routes. Provides potential for cross-checking dosage form and route. Route is an optional because it is pre-coordinated with SubstanceAdministration.code when using SNOMED. Prescription.route ZDP.14.2 Compound.452-E8 RXR.1 routeCode is mandatory and apporachSiteCode is required if not using SNOMED | 0-1 | Opt | maxDoseQuantity : SET<RTO<PQ.DRUG,PQ.TIME>>  Business name: D:Maximum Daily/Weekly Doses The maximum amount of the dispensed medication to be administered to the patient in a 24-hr period (doses per day) or in a 7 day period (doses per week). This field can only capture maximum doses based on explicit time periods. Dosage maximums based on other constraints such as patient lifetime, menstrual cycles must be recorded using additional dosage instruction comments. Sets an upper boundary for the quantity of the drug to be administered over a specified period of time. Particularly useful for PRN medications. ZPB3.5(denominator=1D) | 0-2 | Req | administrationUnitCode : (AdministrableDrugForm)  Business name: Dosage Unit Identifies how the drug is measured for administration. Specified when not implicit from the drug form (e.g. puff, inhalation, drops, etc.). Needed when the dosage unit is not expressed as part of the dose quantity (mg, mL) or implicit as part of the drug form (capsules, tablets). Examples are Puffs, Actuations, etc. | 0-1 | Req | | consumable : Consumable1 | 0-1 | Req | | component1 : Component | 0-1 | Req | | component2 : Component17 | 0-20 | Req |
|
COCT_MT270010CA.DosageLine  Business name: Structured Dosage Lines This information, along with the order/sequence of the dosage lines, constitutes the details of a structured dosage instruction. Enables SIG instructions to be discretely specified. Also, supports scaling doses and parallel dose specification. Either an Ad-hoc Dosage Line or (Dosage Timing/Frequency + Dosage Range + possibly Dosage Rate) may be specified t one time } |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : (x_ActMoodDefEvnRqo)  Business name: Dosage Usage Context Indicates the context of the administration. moodCode = RQO, for administration instruction on orders moodCode = EVN, for administration instruction on dispenses moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs). Puts the class in context, and is therefore mandatory. - moodCode must be DEFN for drug definitions (such as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications | 1 | Mand | text :  Business name: C:Ad-hoc Dosage Instruction A free form description of how the dispensed medication is to be administered to the patient. This field must not be used for components of the prescription that are coded elsewhere.(e.g. Coded Dosage Timing). Not all dosage instructions can easily be expressed in formal terms Allows dosage instructions to be sent across as one string of information without breaking it up. DispensedItem.instruction Prescription.instruction D99.02 X0201 ZPB3.16 DRU.030-02 | 0-1 | Req | effectiveTime : GTS.BOUNDEDPIVL  Business name: C:Dosage Timing/Frequency A structure describing the frequency (how often the drug is to be administered), offset (elapse time between administrations) represented by one line of dosage administration instruction. Includes the overall time-period the dosage instruction applies. Together with the dose quantity, indicates the overall quantity of drug. DosageItem.Duration(OuterInterval.Width) DosageItem.StartDate(OuterInterval.Low) RepeatPattern.PatternCode(PIVL - codes will need to be mapped to and from formal GTS expressions) RepeatPattern.uncodedPattern (PIVL.originalText) ZDP.13.2.1 (PIVL.period) DP.13.2.2 (single time or list of times) PID.13.3 (outer IVL<TS>.width) PID.13.4 (outer IVL<TS>.low) PID.13.5 (outer IVL<TS>.high) Frequency | 0-1 | Req | doseQuantity : URG<PQ.DRUG>  Business name: D:Dosage Range This specifies the minimum and maximum amount of the medication to be taken during a single administration. Where no range is needed, a single value should be specified as the center, with a width of 0. Enables the checking of administration compliance that could results in fill-too-soon/fill-too-late contraindications. Supports circumstances where the dose can vary. (e.g. 1-2 tablets) DosageItem.DosageRange ZDP.13.1 Dosage | 0-1 | Req | rateQuantity : URG<PQ.TIME>  Business name: E:Dosage Rate For intravenous and other such routes, this is the time period over which one dose is to be administered. The flow rate is determined by dividing the dose quantity by the Dosage rate. Required for intravenous administration | 0-1 | Req | | trigger : Trigger | 0-1 | Req | | component : Component18 | 0-1 | Req |
| |
COCT_MT270010CA.SupplementalInstruction  Business name: Additional SIG Instruction This is a modifier for a specific dosage line or for the entire SIG. Examples are: On empty stomach, At breakfast, before bedtime, etc. Adds further constraint or flexibility to the primary administration instruction. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : (x_ActMoodDefEvnRqo)  Business name: Dosage Usage Context Indicates the context of the administration. moodCode = RQO, for administration instruction on orders moodCode = EVN, for administration instruction on dispenses moodCode = DEF, for administration instruction on medication definition documents/references (typically, monographs). Puts the class in context, and is therefore mandatory. - moodCode must be DEFN for drug definitions (such as as monographs) - moodCode must be RQO for orders; - moodCode must be EVN for dispenses and recording of other medications { x.; } | 1 | Mand | text :  Business name: F:Additional Dosage Instruction A free form textual description of extended instruction regarding the administration of the drug. Allows for expression of non-codable qualifiers such as: 'on an empty stomach', 'add water' etc; which do not affect calculations of frequencies or quantity. This attribute is marked as 'mandatory' as it is the only information that can be specified here. ZDP.13.8 | 1 | Mand |
| |
|
|
|
|---|
| COCT_MT280001CA.CrossReference  Business name: Previous Billable Act Cross Reference Used to reference a previous act (e.g. billable act) by including its Act.id. May only be used to reference a billable act in the SAME message, not for past messages (this would require adjudicators to keep a lot of history). Used to reference a previous act (e.g. billable act) by including its Act.id. May only be used to reference a billable act in the SAME message, not for past messages (this would require adjudicators to keep a lot of history). |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS>  Business name:
) (Act.id. Act.id. referencing a previous act (e.g. billable act) in the SAME message, Used to reference a previous act (e.g. billable act) by including its Act.id. May only be used to reference a billable act in the SAME message, not for past messages (this would require adjudicators to keep a lot of history). | 1 | Mand |
|
|
|
|
|---|
| |
COCT_MT290000CA.BillableClinicalService  Business name: Billable Clinical Service Service which was provided and is referenced in this encounter Patient classes are not referenced in the billable acts, as they are noted in the parent model (e.g. Invoice message) as the CoveredPartyAsPatient |
|---|
classCode : "PROC" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: Service event ID Can be used to uniquely identify a service event | 0-1 | Req | code : (ActProcedureCode)  Business name: Procedure code procedure cd, CPT cd, supply cd | 1 | Mand | effectiveTime : IVL.WIDTH<TS.FULLDATE>  Business name: Duration, date/time of occurrence Duration, date/time of occurrence | 1 | Mand | reasonCode : SET<CV> (ActBillableClinicalServiceReason)  Business name: Service Reason clinical reasons for service, not related or specified by diagnosis. e.g. duplicate therapy, fraudulent prescription (clinical reasons for service, not related or specified by a diagnosis e.g. duplicate therapy, fraudulent prescription | 0-5 | Req | | product : Product | 0-10 | Req | | secondaryPerformer : ProviderSupervisor | 0-1 | Req | | performer : ResponsibleProvider | 0-1 | Req | | referrer : ServiceReferrer | 0-1 | Req | | consultant : Consultant | 0-1 | Req | | location : ServiceLocation | 0-1 | Req | | pertinentInformation1 : AccidentInformation | 0-5 | Req | | pertinentInformation2 : EncounterInformation | 0-1 | Req | | pertinentInformation3 : DiagnosisInformation | 0-10 | Req |
| |
COCT_MT290000CA.Diagnosis  Business name: Diagnosis Diagnosis More than 1 diagnosis may be specified to justify the performing of a particular service. A specific diagnosis code must always be specified, and may be supplemented by descriptive text. For some services (e.g. provider's review of a file), the diagnosis may not be known. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActDiagnosisCode)  Business name: Diagnosis type admit, intermediate, discharge diagnosis | 1 | Mand | text :  Business name: Diagnosis Description Can be used to supplement a diagnostic code Can be used to supplement a diagnostic code | 0-1 | Req | value : (DiagnosisValue)  Business name: Diagnosis Value Diagnosis Code eg. ICD-10-CA code. | 1 | Mand |
| |
| COCT_MT290000CA.HealthCareProvider  Business name: Healthcare Provider Healthcare Provider |
|---|
classCode : "PROV" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: Provider identifiers Provider ID, eg. Prof. license no. More than provider identifier could be provided, eg. for dental claims. | 0-9 | Req | code : (HealthcareProviderRoleType)  Business name: Provider Type Allows for crosswalks between speciality code sets | 1 | Pop | | healthCareProviderPerson : ProviderPerson | 0-1 | Req |
|
| COCT_MT290000CA.ManufacturedProduct  Business name: Manufactured Product Pertinent info about manufactured Product Scoped by Manufacturer Must have Role.cd or ManufacturedMaterial.cd |
|---|
classCode : "MANU" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Product Number serial number | 0-1 | Req | code : (ProductRoleType)  Business name: Manufactured Product Code (UPC/GTIN/pseudo UPC number manufacturers item/catalogue number | 0-1 | Req | | manufacturedMaterial : ManufacturedMaterial | 0-1 | Req | | manufacturerManufacturedProductOrganization : ManufacturedProductOrganization | 0-1 | Req |
|
| |
| COCT_MT290000CA.ProviderPerson  Business name: Provider Person Telecom, gender, birth time, addr are only required if provider is not known to the Payor Association/ProviderPerson can only be specified for the Referrer for a non-known Provider (e.g. out of jurisdiction). Association/ProviderPerson can only be specified for the Referrer for a non-known Provider (e.g. out of jurisdiction). |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: Name of Provider Name of person providing service or drug | 1 | Mand | telecom : TEL.PHONEMAIL  Business name: contact no. contact info. for Provider | 0-1 | Req | administrativeGenderCode : (AdministrativeGender)  Business name: Provider Gender Telecom, gender, birth time, addr are only required if provider is not known to the Payor | 0-1 | Req | birthTime : TS.FULLDATE  Business name: Provider Date of Birth Telecom, gender, birth time, addr are only required if provider is not known to the Payor | 0-1 | Req | addr : AD.BASIC  Business name: Provider Address Telecom, gender, birth time, addr are only required if provider is not known to the Payor Can be used to specify jurisdiction for OOJ providers | 0-1 | Req |
|
| |
| |
|
|
|
|---|
| |
| COCT_MT300000CA.Content  Business name: Package Contents Details of Product being dispensed |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG  Business name: Package Size package size | 0-1 | Opt | | containedManufacturedMaterialKind : ManufacturedMaterialKind | 1 | Pop |
|
| |
| |
| |
COCT_MT300000CA.PatientEncounter  Business name: Patient Encounter Patient Encounter details Can be used to reference discharge and admit dates for an encounter in a hospital. |
|---|
classCode : "ENC" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: Encounter ID A unique identifier that refers to the interaction with the patient. | 1 | Pop | effectiveTime : TS.FULLDATE  Business name: Encounter Date The start and end dates of the interaction with the patient, eg. for dispensing, the interval would be when the patient handed the prescription to the pharmacy to when the patient picked up the medication. | 0-1 | Req |
| |
COCT_MT300000CA.PharmacistRole  Business name: Pharmacist Role Details of the pharmacist |
|---|
classCode : "ROL" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: Pharmacist ID Pharmacist ID | 1 | Pop |
| |
COCT_MT300000CA.PrescriberPerson  Business name: Person Prescribing Person Prescribing |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: Prescriber Name Name of person prescribing | 1 | Pop | telecom : LIST<TEL.PHONEMAIL>  Business name: Prescriber Telephone Number Telephone no. of the prescriber used for Coverage Extension to contact prescriber | 0-3 | Req |
| COCT_MT300000CA.PresriberRole  Business name: Playing Prescribe Person ID cannot be mandatory as it may not be present on a pre-determination |
|---|
classCode : "ROL" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: Prescriber ID Prescriber ID This is mandatory for Invoices and required with nullFlavor for Pre-Determinations. | 1 | Pop | | playingPrescriberPerson : PrescriberPerson | 1 | Pop |
|
| |
| COCT_MT300000CA.SubstanceAdministrationIntent  Business name: Expected Start Time Expected start time. For methadone, this indicated when the drug is expected to be taken. ID cannot be mandatory as it may not be present on a pre-determination |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : "INT" (ActMood) | 1 | Mand | id : II.BUS  Business name: Dispense ID filler transaction number for dispense | 0-1 | Req | effectiveTime : IVL<TS.DATE>  Business name: Substance Administration Time Substance Administration Time (For methadone, this indicates when the drug is expected to be taken Used effectiveTime for methadone only | 0-1 | Req | priorityCode : (x_ActPriorityPharmacy)  Business name: In lieu of days supply. In lieu of days supply, specify PRN, UD or use NullFlavor of UNK (unknown), else not specified. for PRN, UD or unknown (use NullFlavor In lieu of days supply, specify PRN, UD or use NullFlavor of UNK (unknown), else not specified. | 0-1 | Req | | inFulfillmentOf : FulfillsOrder | 0-1 | Req | | component : Component | 0-1 | Req | | subjectOf : Subject | 0-10 | Req |
|
| |
| |
COCT_MT300000CA.SupplyOrder  Business name: Original Prescription When number of repeats is unlimited, specify Null Flavour of positive infinity in expected_use_time |
|---|
classCode : "SPLY" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | effectiveTime : IVL.HIGH<TS.FULLDATE>  Business name: Last Allowed Dispense last allowed dispense Only end date of effective_time can be specified | 0-1 | Req | repeatNumber : INT.POS  Business name: Number of Refills + 1 # refills + 1 | 0-1 | Req |
|
|
|
|
|---|
| COCT_MT470002CA.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 | contextControlCode : "OP" (ContextControl) | 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 :  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 | | personalRelationship : PersonalRelationship | 1 | Pop |
|
| COCT_MT470002CA.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. |
|---|
classCode : "CONS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  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 : "INFA" (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 : (ActConsentInformationAccessOverrideReason)  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) If author1 (provider) is specified, reason code must be specified. | 0-1 | Req | | subject1 : Subject | 1 | Mand | | author1 : Author | 0-1 | Req | | author2 : Author2 | 0-1 | Req | | subject2 : Subject2 | 1 | Mand |
|
| |
| |
| | COCT_MT470002CA.Subject3 |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | actDefinition : ActDefinition | 1 | Mand |
|
|
|
|
|---|
| COCT_MT470012CA.Author  Business name: b:consented to by Indicates that the consent was provided by the patient, client, provider or representative. Consent can be provided by the patient or representative or the provider. Authorization.Person Authorization.signatory(PT) |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 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 :  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 | | personalRelationship : PersonalRelationship | 1 | Pop |
|
| COCT_MT470012CA.ConsentEvent  Business name: Consent Information pertaining to a patient's (or client or provider) agreement/acceptance to have his/her clinical or demographic 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, client, or provider 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. |
|---|
classCode : "CONS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: D:Consent Form Number A unique identifier for a specific consent for a patient, client or provider. Provides a traceable audit link between a physical consent form and its electronic record Authorization.formNumber | 0-1 | Req | code : "INFA" (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, client, or provider retains a level of control. Authorization.endTime (high) | 0-1 | Req | reasonCode : (ActConsentInformationAccessOverrideReason)  Business name: E:Consent Override Reason Indicates a reason for overriding a patient's (or client or provider) consent rules. Important for audit purposes Authorization.reason (mnemonic) Authorization.comment (original text) If author1 (provider) is specified, reason code must be specified. | 0-1 | Req | | subject1 : Subject | 1 | Mand | | author1 : Author | 0-1 | Req | | author2 : Author2 | 0-1 | Req | | subject2 : Subject2 | 1 | Mand |
|
| |
| |
| | COCT_MT470012CA.Subject3 |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | actDefinition : ActDefinition | 1 | Mand |
|
|
|
|
|
|---|
| COCT_MT490000CA.ContentPackagedProduct  Business name: Package Contents Can be used to include elements within a product such as a battery charger that is part of a wheelchair Can be used to include elements within a product such as a battery charger that is part of a wheelchair |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG  Business name: Package Quantity number of items in the package | 1 | Pop | | containedManufacturedMaterialKind : ManufacturedMaterialKind | 0-1 | Req |
|
| |
COCT_MT490000CA.HealthCareProvider  Business name: Healthcare Provider Person providing healthcare service |
|---|
classCode : "PROV" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: Provider ID More than 1 Provider identifier can be provided for a particular role, e.g. some dental claims. An Id may not be available for out of jurisdiction providers and consulltants. | 0-9 | Req | code : (HealthcareProviderRoleType)  Business name: Healthcare Provider code code denoting healthcare Provider Type | 1 | Pop | | healthCareProviderPerson : ProviderPerson | 0-1 | Req |
| |
COCT_MT490000CA.ManufacturedProduct  Business name: Manufactured Product Playing Role of Manufactured Product Scoped by Manufacturer Must have Organization if you dont have UPC/GTIN or pseudo UPC |
|---|
classCode : "MANU" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Product ID serial number | 0-1 | Req | code : (ProductRoleType)  Business name: Product Code code denoting product type | 1 | Mand | | manufacturedMaterialKind : ManufacturedMaterialKind | 0-1 | Req | | manufacturerManufacturedProductOrganization : ManufacturedProductOrganization | 0-1 | Req |
| |
| |
| |
COCT_MT490000CA.ProviderPerson  Business name: Provider Person Telecom, gender, birth time, addr are only required if provider is not known to the Payor Telecom, gender, birth time, addr are only required if provider is not known to the Payor Association/ProviderPerson can only be specified for the Referrer for a non-known Provider (e.g. out of jurisdiction). |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: Provider Name Name of Provider | 1 | Mand | telecom : TEL.PHONEMAIL  Business name: Provider Telecom Telephone no. of provider only required if provider is not known to the Payor | 0-1 | Req | administrativeGenderCode : (AdministrativeGender)  Business name: Provider Gender only required if provider is not known to the Payor | 0-1 | Req | birthTime : TS.FULLDATE  Business name: Provider Birth date only required if provider is not known to the Payor | 0-1 | Req | addr : AD.BASIC  Business name: Provider Address Can be used to specify jurisdiction for OOJ providers | 0-1 | Req |
| |
| COCT_MT490000CA.SupplyEvent  Business name: Billable Clinical Product Product being billed Patient classes are not referenced in the billable acts, as they are noted in the parent model (e.g. Invoice message) as the CoveredPartyAsPatient |
|---|
classCode : "SPLY" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.PUBLIC  Business name: Billable Clinical Product ID receipt number for the sale or rental | 0-1 | Req | code : (ActProductAcquisitionType)  Business name: Method of payment for product. Rent or Sale. | 1 | Mand | effectiveTime : IVL<TS.DATE>  Business name: Time of Sale Date that the sale is transacted (change of ownership for a sale) and could be different than the date that it is invoiced. Similar in concept to the service date. For rentals, this is the rental period. | 1 | Mand | | product : Product | 1 | Mand | | performer : ResponsibleProvider | 0-1 | Req | | referrer : ProductReferrer | 0-1 | Req | | consultant : Consultant | 0-1 | Req | | origin : ProductLocationOrigin | 0-1 | Req | | destination : ProductLocationDestination | 0-1 | Req | | location : ServiceLocation | 0-1 | Req | | pertinentInformation : DiagnosisInformation | 0-10 | Req |
|
COCT_MT490000CA.Warrantor  Business name: Warrantor Role of warrantor |
|---|
classCode : "WRTE" (RoleClass) | 1 | Mand | effectiveTime : IVL<TS.DATE>  Business name: Time of warranty time of warranty | 1 | Mand | | warrantingWarrantorOrganization : WarrantorOrganization | 0-1 | Req |
| COCT_MT490000CA.WarrantorOrganization  Business name: Warrantor Organisation Organization that holds warranty Organization that holds warranty |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: Warrantor Organisation Name name of Organization that holds warranty | 1 | Mand | telecom : TEL.PHONE  Business name: Warrantor Organisation telecom Warrantor Organization telephone number | 0-1 | Req |
|
|
|
|
|---|
| |
| |
| COCT_MT680000CA.AdjudicatedInvoiceElementDetail  Business name: Invoice Element Detail |
|---|
classCode : "INVE" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActInvoiceDetailCode)  Business name: Product/service Code Product/Service Code e.g. Office Visit ,Taxes, Markup, Dispense, including Product/Service Code Modifier e.g. northern isolation, off hours specialty, on call Domain for AdjudicatedInvoiceElementDetail.code is GenericBillableItemModifier | 1 | Mand | unitQuantity : PQ.BASIC  Business name: Quantity per Unit e.g. 3 {boxes} | 1 | Pop | unitPriceAmt : RTO<MO.CAD,PQ.BASIC>  Business name: Price Per Unit e.g. $50 CAD/ 1 {box} | 1 | Pop | netAmt : MO.CAD  Business name: Invoice Element Amount billed = unit_qty * unit_price_amt * factor_nbr * points_nbr. E.g. $150 CAD | 1 | Mand | factorNumber : INT.POS  Business name: Multiplier for Taxes. multiplier, can be used for tax percentages such as 0.07 | 0-1 | Req |
|
| |
| |
| |
| |
| |
| |
| COCT_MT680000CA.InvoiceElementIntent2  Business name: Invoice element Intent 2 |
|---|
classCode : "INVE" (ActClass) | 1 | Mand | moodCode : "INT" (ActMood) | 1 | Mand | code : (ActInvoiceDetailCode)  Business name: Generic Service Codes (Product/Service Code e.g. Office Visit ,Taxes, Markup, Dispense, including Product/Service Code Modifier e.g. northern isolation, off hours specialty, on call Domain for InvoiceElementIntent2.code is GenericBillableItemModifier | 1 | Mand | unitQuantity : PQ.BASIC  Business name: Unit Quantity e.g. 3 {boxes} | 0-1 | Req | unitPriceAmt : RTO<MO.CAD,PQ.BASIC>  Business name: Price per unit e.g. $50 CAD/ 1 {box} | 0-1 | Req | netAmt : MO.CAD  Business name: Total amount billed for line item/elements. (= unit_qty * unit_price_amt * factor_nbr * points_nbr. E.g. $150 CAD | 1 | Mand | factorNumber : INT.POS  Business name: Factor Number multiplier, can be used for tax percentages such as 0.07 | 0-1 | Req |
|
| |
|
|
|
|---|
COCT_MT910102CA.PersonalRelationship  Business name: Related Person Describes a person (other than a health-care provider or employee) 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. Also used with a relationship of "self" when the patient themselves is providing the care. The expectation is that the person can be found in the client registry. Important for tracking source of information for decision making and other actions taken on behalf of a patient. |
|---|
classCode : "PRS" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: B:Related Person Identifier A unique identifier for the responsible person (as found in a client registry). Allows a person to be uniquely referred to and retrieved from the client registry and is therefore mandatory. 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 | Mand | code : (x_SimplePersonalRelationship)  Business name: C:Responsible Person Type A coded value indicating how the responsible person is related to the patient. If the code is "SELF", it indicates that the action was performed by the patient themselves. Essential for understanding the authority to perform certain actions as well as the context of the information and is therefore mandatory. E.g. A 'friend' may not be able to make consent decisions, but may be able to pick up dispenses. The element uses CWE to allow for the capture of Responsible Person Type concepts not presently supported by the approved code system(s). In this case, the human-to-human benefit of capturing additional non-coded values outweighs the penalties of capturing some information that will not be amenable to searching or categorizing. | 1 | Mand | | relationshipHolder : RelatedPerson | 1 | Mand |
| |
|
|
|
|---|
COCT_MT910107CA.PersonalRelationship  Business name: Related Person Describes a person (other than a health-care provider or employee) 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. Used when the person cannot be found in the Client registry. Important for tracking source of information for decision making and other actions taken on behalf of a patient. |
|---|
classCode : "PRS" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: B:Related Person Identifier A unique identifier for the related person. May include PHNs, drivers license or other identifiers. 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:Related Person Type A coded value indicating how the related person is related to the patient. Essential for understanding the authority to perform certain actions as well as the context of the information and is therefore mandatory. E.g. A 'friend' may not be able to make consent decisions, but may be able to pick up dispenses. The element uses CWE to allow for the capture of Related Person Type concepts not presently supported by the approved code system(s). In this case, the human-to-human benefit of capturing additional non-coded values outweighs the penalties of capturing some information that will not be amenable to searching or categorizing. | 1 | Mand | | relationshipHolder : RelatedPerson | 1 | Mand |
| | COCT_MT910107CA.RelatedPerson |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  | 1 | Mand | telecom : SET<TEL.PHONEMAIL>  | 0-5 | Req | addr : AD.BASIC  | 0-1 | Req |
|
|
|
|
|---|
| COCT_MT910108CA.Person |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: A:Related 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 | telecom : SET<TEL.PHONEMAIL>  Business name: E:Related Person Phones and Emails The phone number(s) and email address(s) by which a related person may be contacted as known by the client registry. Used to contact the related person. | 0-5 | Req | addr : AD.BASIC  Business name: D:Related Person Address The mail and/or physical address associated with a related person as known by the client registry. Used to contact the related person. | 0-1 | Req |
| COCT_MT910108CA.PersonalRelationship  Business name: Related Person Describes a person (other than a health-care provider or employee) 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. Also used with a relationship of "self" when the patient themselves is providing the care. Represents information retrieved from the client registry. Important for tracking source of information for decision making and other actions taken on behalf of a patient. |
|---|
classCode : "PRS" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: B:Related Person Identifier A unique identifier for the related person (as found in a client registry). Allows a person to be uniquely referred to and retrieved from the client registry and is therefore mandatory. 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 | Mand | code : (x_SimplePersonalRelationship)  Business name: C:Responsible Person Type A coded value indicating how the person is related to the patient. If the code is "SELF", it indicates that the action was performed by the patient themselves. EPHS:this cmet is used for self-reports as well as reports by other related parties Essential for understanding the authority to perform certain actions as well as the context of the information and is therefore mandatory. E.g. A 'friend' may not be able to make consent decisions, but may be able to pick up dispenses. The element uses CWE to allow for the capture of Responsible Person Type concepts not presently supported by the approved code system(s). In this case, the human-to-human benefit of capturing additional non-coded values outweighs the penalties of capturing some information that will not be amenable to searching or categorizing. | 1 | Mand | | relationshipHolder : Person | 1 | Mand |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| |
COCT_MT960002CA.PositionCoordinate  Business name: Coordinate Axis Describes the postion of the location along a specific axis. Defines the position of the location |
|---|
classCode : "POSCOORD" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ObservationCoordinateAxisType)  Business name: Coordinate Axis Type Identifies the individual coordinate in the coordinate system inclusive of any transformations or projections. Examples of corordinate types are: meridian, range, township, longitude, latitude, lot, block, etc. Acts as the "name" in the name-value pair that expresses a coordinate and is therefore mandatory | 1 | Mand | value : REAL.COORD  Business name: Coordinate Axis Value Denotes the individual coordinate value as a a physical quantity. For example, lot number, range number, latitude, etc. Actually expresses the location along the axis. Because unknown axis positions can simply be omitted, this attribute is mandatory. | 1 | Mand |
|
|
|
|
|---|
COMT_MT001101CA.ActRequest  Business name: Referenced Record References an existing event record by identifier. As a request, refers to the event to be acted upon or which has been acted upon. As a response, may be used to indicate the identifier assigned to a created object. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: Record Ids The identifier assigned by the central system (EHR) to the Event record being referred to. Allows the event record to be uniquely referenced and is therefore mandatory. | 1-2 | Mand |
|
|
|
|
|---|
COMT_MT001103CA.ActEvent  Business name: Referenced Record References an existing event record by identifier. As a request, refers to the event to be acted upon or which has been acted upon. As a response, may be used to indicate the identifier assigned to a created object. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: Record Ids The identifier assigned by the central system (EHR) to the Event record being referred to. Allows the event record to be uniquely referenced and is therefore mandatory. | 1-2 | Mand |
|
|
|
|
|---|
COMT_MT001104CA.ActEvent  Business name: Referenced Record References an existing event record by identifier. As a request, refers to the event to be acted upon or which has been acted upon. As a response, may be used to indicate the identifier assigned to a created object. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: Record Identifier The identifier assigned by the central system (EHR) to the Event record being referred to. For the retract interaction, the identfier of the control act requested to be nullified. Allows the event record to be uniquely referenced and is therefore mandatory. | 1 | Mand |
|
|
|
|
|---|
COMT_MT001201CA.Role  Business name: Referenced Record References an existing role record by identifier. As a request, refers to the role to be acted upon or which has been acted upon. As a response, may be used to indicate the identifier assigned to a created object. |
|---|
classCode : "ROL" (RoleClass) | 1 | Mand | id : SET<II.PUBLIC>  Business name: Record Ids The identifier assigned by the registry to the role record being referred to Allows the role record to be uniquely referenced and is therefore mandatory. | 1-2 | Mand |
|
|
|
|
|---|
| |
COMT_MT111111CA.RenderedContent  Business name: Rendered Record Conveys a portion of the patient's record as rendered content. Allows simple applications which do not yet support all of the discrete messaging specifications to still access data within the EHR. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActEventCategoryWorkingListCode)  Business name: Rendered Content Type Identifies the type of content contained within the rendered document portion of this class. Identifies what type of data has been returned. This attribute is mandatory because type of data returned must be known for presentation and consumption. | 1 | Mand | text : ED.DOC  Business name: Rendered Content Contains a rendered view of a particular portion of the patients records. E.g. Allergy List, Problem List, Drug List, etc. Provides a human-readable view of a portion of a patient's record when the PoS application may not be capable of handling the discrete data. This attribute is mandatory because the rendered content must be known. | 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 | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: D:Restricted Patient Access Communicates the desire of the patient to restrict access to this Health Condition record. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Methods for accessing masked event records will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). Can also be used to communicate that the information is deemed to be sensitive and should not be communicated or exposed to the patient (at least without the guidance of the authoring or other responsible healthcare provider). Valid values are: 'normal' (denotes 'Not Masked'); 'restricted' (denotes 'Masked'); very restricted (denotes Masked by Regulation); and 'taboo' (denotes 'patient restricted'). The default is 'normal' signifying 'Not Masked'. Either or both of the other codes can be asserted to indicate masking by the patient from providers or masking by a provider from the patient, respectively. 'normal' should never be asserted with one of the other codes. Taboo allows the provider to request restricted access to patient or their care giver. Constraint: Cant have both normal and one of the other codes simultaneously. The attribute is optional because not all systems will support masking. | 0-2 | Opt |
|
|
|
|
|---|
| | 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.BUS  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 | confidentialityCode : SET<CV> (x_BasicConfidentialityKind)  Business name: D:Restricted Patient Access Communicates the desire of the patient to restrict access to this Health Condition record. Provides support for additional confidentiality constraint, giving patients a level of control over their information. Methods for accessing masked event records will be governed by each jurisdiction (e.g. court orders, shared secret/consent, etc.). Can also be used to communicate that the information is deemed to be sensitive and should not be communicated or exposed to the patient (at least without the guidance of the authoring or other responsible healthcare provider). Valid values are: 'normal' (denotes 'Not Masked'); 'restricted' (denotes 'Masked'); very restricted (denotes Masked by Regulation); and 'taboo' (denotes 'patient restricted'). The default is 'normal' signifying 'Not Masked'. Either or both of the other codes can be asserted to indicate masking by the patient from providers or masking by a provider from the patient, respectively. 'normal' should never be asserted with one of the other codes. Taboo allows the provider to request restricted access to patient or their care giver. Constraint: Cant have both normal and one of the other codes simultaneously. The attribute is required because even if a jurisdiction doesn't support masking on the way in, it will need to need to communicate masked data returned from other jurisdictions. | 0-2 | Req | | 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 | | assignedEntity : AssignedEntity | 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.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 | | assignedEntity : AssignedEntity | 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_MT400001CA.Diagnosis  Business name: Diagnosis Conveys information about a diagnosis to be masked Allows masking of items related to a particular medical condition. |
|---|
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. If code is SNOMED, value must not be specified. Otherwise value is mandatory and code must be DX | 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 : "CRT" (ActMood) | 1 | Mand | id : II.BUS  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 : SET<CV> (x_BasicConfidentialityKind)  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-2 | Mand | | directTarget : DirectTarget | 0-1 | Req | | reason : Reason | 0-1 | Req |
|
| |
|
|
|
|---|
|
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| FICR_MT400001CA.Form |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  | 1 | Pop |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| FICR_MT400001CA.Subject |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | annotation : Annotation | 1 | Pop |
| |
| |
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | FICR_MT400003CA.Subject2 |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | annotation : Annotation | 1 | Pop |
|
| |
|
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | FICR_MT400004CA.Subject2 |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | annotation : Annotation | 1 | Pop |
|
| |
|
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
|
|
|
|---|
| |
| |
| |
|
|
|
|---|
| |
|
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | FICR_MT490102CA.Subject |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | annotation : Annotation | 1 | Pop |
|
| FICR_MT490102CA.Subject2 |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | annotation : Annotation | 1 | Pop |
| |
| |
| |
| |
|
|
|
|---|
| |
| |
| |
|
|
|
|
|---|
| |
| FICR_MT500201CA.ContactPerson |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  | 0-1 | Req | telecom : TEL.PHONEMAIL  | 0-1 | Req |
| |
FICR_MT500201CA.CoveredPartyAsPatient  Covered Person Identifier (Assigned by carrier - root of OID) = Subscriber+Dependents Can be a single covered party, an organization, an animal or a group of patients and/or a group of animals. Covered party may be a patient who for the purposes of the invoice is a covered party. |
|---|
classCode : "COVPTY" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Covered Party Identifier | 1 | Pop | code : (CoveredPartyRoleType)  Business name: Covered Party Relationship to Policy Holder | 1 | Mand | | Choice: coveredPartyAsPatientChoice : CoveredPartyAsPatientChoice | 1 | Mand | | »» coveredPartyAsPatientPerson : CoveredPartyAsPatientPerson | 0-1 | Opt | | »» coveredPartyAsPatientAnimal : CoveredPartyAsPatientAnimal | 0-1 | Opt | | subjectOf : Subject | 0-10 | Req | | indirectAuthority : IndirectAuthorithyOver | 0-1 | Req |
| |
| |
| |
| |
| |
| |
| |
| |
| FICR_MT500201CA.InvoiceElementReason  This is where each benefit group will insert their billable act (e.g. Pharmacy Dispense Billable Act). Each Billable Act is a CMET, contained in the A_Billable CMET. Refer to the CMET for more information. The act will be in intent (INT) mood when requesting authorization |
|---|
typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | Choice: billableActChoice : A_BillableActChoice | 1 | Pop | | »» billableClinicalService : BillableClinicalService | 0-1 | Opt | | »» supplyEvent1 : SupplyEvent | 0-1 | Opt | | »» supplyEvent2 : SupplyEvent | 0-1 | Opt | | »» crossReference : CrossReference | 0-1 | Opt |
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| FICR_MT510201CA.CoveredPartyAsPatient  Covered Person Identifier (Assigned by carrier - root of OID) = Subscriber+Dependents Can be a single covered party, an organization, an animal or a group of patients and/or a group of animals. Covered party may be a patient who for the purposes of the invoice is a covered party. |
|---|
classCode : "COVPTY" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Covered party Identifier | 1 | Mand | code : (CoveredPartyRoleType)  Business name: Relationship to Policy Holder | 1 | Mand | | indirectAuthority : IndirectAuthorithyOver | 0-1 | Req |
|
| |
| |
FICR_MT510201CA.FinancialTransactionIntent  If an Adjudicator adjudicates for multiple insurance policies (EOBs) for multiple Payors and/or Payees, there would be more than 1 Payment Intent payload in the Results message Amt must be positive or 0 for completed Adjudication Results messages Amt must be negative or 0 for Invoice Cancel Results messages |
|---|
classCode : "XACT" (ActClass) | 1 | Mand | moodCode : "INT" (ActMood) | 1 | Mand | id : II.PUBLIC  Business name: Payment Intent Identifier | 1 | Mand | statusCode : (ActStatus)  Business name: Payment Intent Status | 1 | Mand | effectiveTime : TS.DATETIME  Business name: Payment Intent Date/Time | 0-1 | Req | amt : MO.CAD  Business name: Total Amount of Payment Intent | 0-1 | Req | | credit : Credit | 0-1 | Req | | debit : Debit | 0-1 | Req | | pertinentInformation : PertinentInformation2 | 0-5 | Req | | reasonOf : Reason2 | 1-10 | Pop |
| | FICR_MT510201CA.Form |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | telecom : TEL.URI  | 0-1 | Req |
|
| |
| |
| |
| |
| |
| |
| FICR_MT510201CA.Reference  Multiple references to submitted invoice elements provides support for code substitution where the number of submitted fee items is consolidated on the adjudication results (e.g. 3 items to 1) Each submitted invoice element must have 1 AdjudicationResults instance unless its parent is adjudicated as submitted Association mandatory for Root AdjudicatedInvoiceElementGroup and all associations that point to submitted invoice elements. |
|---|
typeCode : "REFR" (ActRelationshipType) | 1 | Mand | | Choice: invoiceElementChoice : InvoiceElementChoice | 1 | Pop | | »» invoiceElementGroup : InvoiceElementGroup | 0-1 | Opt | | »» invoiceElementDetail : InvoiceElementDetail | 0-1 | Opt |
|
| |
| |
|
|
|
|---|
| |
| FICR_MT600201CA.ContactPerson |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  | 0-1 | Req | telecom : TEL.PHONEMAIL  | 0-1 | Req |
| FICR_MT600201CA.CoveredPartyAsPatient  Covered Person Identifier (Assigned by carrier - root of OID) = Subscriber+Dependents Can be a single covered party, an organization, an animal or a group of patients and/or a group of animals. Covered party may be a patient who for the purposes of the invoice is a covered party. |
|---|
classCode : "COVPTY" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Covered Party Identifier | 1 | Pop | code : (CoveredPartyRoleType)  Business name: Covered Party Relationship to Policy Holder | 1 | Mand | | Choice: coveredPartyAsPatientChoice : CoveredPartyAsPatientChoice | 1 | Mand | | »» coveredPartyAsPatientPerson : CoveredPartyAsPatientPerson | 0-1 | Opt | | »» coveredPartyAsPatientAnimal : CoveredPartyAsPatientAnimal | 0-1 | Opt | | subjectOf : Subject | 0-10 | Req | | indirectAuthority : IndirectAuthorithyOver | 0-1 | Req |
|
| |
| |
| |
| |
| |
| |
| |
| FICR_MT600201CA.InvoiceElementReason  This is where each benefit group will insert their billable act (e.g. Pharmacy Dispense Billable Act). Each Billable Act is a CMET, contained in the A_Billable CMET. Refer to the CMET for more information. The act will be in intent (INT) mood when requesting authorization |
|---|
typeCode : "RSON" (ActRelationshipType) | 1 | Mand | | Choice: billableActChoice : A_BillableActChoice | 1 | Pop | | »» billableClinicalService : BillableClinicalService | 0-1 | Opt | | »» supplyEvent1 : SupplyEvent | 0-1 | Opt | | »» supplyEvent2 : SupplyEvent | 0-1 | Opt | | »» crossReference : CrossReference | 0-1 | Opt |
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
|
|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
FICR_MT610201CA.AdjudicationResultReference  Multiple references to submitted invoice elements provides support for code substitution where the number of submitted fee items is consolidated on the adjudication results (e.g. 3 items to 1) Each submitted invoice element must have 1 AdjudicationResults instance unless its parent is adjudicated as submitted Association mandatory for Root AdjudicatedInvoiceElementGroup and all associations that point to submitted invoice elements. |
|---|
typeCode : "REFR" (ActRelationshipType) | 1 | Mand | | Choice: invoiceElementChoice : InvoiceElementChoice | 1 | Pop | | »» invoiceElementGroup : InvoiceElementGroup | 0-1 | Opt | | »» invoiceElementDetail : InvoiceElementDetail | 0-1 | Opt |
| |
| |
| |
| |
FICR_MT610201CA.CoveredPartyAsPatient  Covered Person Identifier (Assigned by carrier - root of OID) = Subscriber+Dependents Can be a single covered party, an organization, an animal or a group of patients and/or a group of animals. Covered party may be a patient who for the purposes of the invoice is a covered party. |
|---|
classCode : "COVPTY" (RoleClass) | 1 | Mand | id : II.BUS  Business name: Covered Party Identifier | 1 | Pop | code : (CoveredPartyRoleType)  Business name: Relationship to Policy Holder | 1 | Mand | | indirectAuthority : IndirectAuthorithyOver | 0-1 | Req |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
|
|---|
FICR_MT620000CA.InvoiceElementGroup  Business name: Invoice Type Cancel reasons are noted in the control wrapper |
|---|
classCode : "INVE" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: Invoice Grouping Identifiers For example: 1. unique invoice group identifier, independent of adjudicator recipient. 2. sequential invoice grouping identifier by adjudicator. Obligation on adjudicator is to return and communicate about this item with all identifiers (i.e. identifier 1. and 2.). There are some situations where more than 1 identifier for this object can be included in a message. | 1 | Mand | code : (ActInvoiceGroupType)  Business name: Invoice Type Invoice Type e.g. Healthcare Services, Rx Dispense, Rx Compound, Healthcare Goods, Preferred Accomodation Each Invoice Type is used to specify 1. vocabulary, 2. structure of the Invoice Element Choice and 3. which Billable Act(s) can be included for the specified Invoice Type. Information on constraints for the Invoice Type will be found in the NeCST Message Specifications. Each Benefit Group will indicate which Invoice Types will be supported by that Benefit Group. Invoice Types will not generate unique and distinct XML schemas that can tested independent of each other. They must be tested together within an Message Type. | 1 | Mand | netAmt : MO.CAD  Business name: Invoice sub-total Invoice sub-total - This is the sum of the Submitted Invoice Line amounts; Identifies the total monetary amount billed for the invoice element. For Cancel Request: This would serve as a cross-check for the Adjudicator for the Invoice Grouping that is being cancelled. Attribute cannot be mandatory as it may not be present for a Coverage Extension Request. | 1 | Mand |
|
|
|
|
|---|
FICR_MT630000CA.AdjudResultsGroup  Business name: Adjudicated Results Group Group of results for line items/invoice elements previously adjudicated. Payor must be specified for the root Act ONLY. Payee is optional, but may only be specified for the root Act. |
|---|
classCode : "INVE" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActInvoiceAdjudicationPaymentSummaryType)  Business name: Breakdown of Financial Activity This code describes the breakdown of the financial activity and defines the 'categorization; Only really relevant for summaries. For Payment Advice: For Vision Care payment advices, RETRO adjustments will always include references to the EOBs that made up the retroactive adjustment. For Payment Advice: For Pharmacy payment advices, RETRO adjustments will not include references to the EOBs that made up the retroactive adjustment. Providers must submit a Payment Advice Query message to get the EOBs referenced by the RETRO amount. The Payment Advice Detail message, however, is not currently supported in Pharmacy. For Payment Advice: Code also specifies the type of adjustment for a payment advice (e.g. CFWD - carry forward adjustment). | 1 | Mand | effectiveTime : IVL<TS.FULLDATE>  Business name: Time period for the payment Time period for the payment or summary period. For Payment Advice: Can also indicate time period over which the clawback and/or retro adjustment applies. | 1 | Pop | netAmt : MO.CAD  Business name: Summary Period Amt Summary Period Amt - Grand total of all SOFA observations contained in this summary On SOFA Summary, this could be used to specify the amount that will be included in the Payment Advice. In this situation, it should equal the net effect of all AdjudResultsGroupSummaryData elements that would appear in the Payment Advice. | 1 | Mand | | summary : AdjudResultsGroupSummary | 0-10 | Opt |
| |
FICR_MT630000CA.AdjudResultsGroupSummaryData  Business name: Summary Details Summarised Details of the Adjudicated Results for a group of Invoice elements/line items. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActInvoiceElementSummaryType)  Business name: Summary Period Amt Summary Period Amt (defines the 'categorization'. Only really relevant for summaries. | 1 | Pop | value : PQ.BASIC  Business name: Summary Total Amt Summary Total Amt PQ or MO only - Value of summary Constrain Value to PQ or MO data types only | 1 | Pop |
| |
FICR_MT630000CA.AdjudicatedInvoiceElementGroup  Business name: Adjudicated Invoice Element Group Group of Invoice Elements being referenced; ie. group of billable items. |
|---|
classCode : "INVE" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: Adjudication Result Id Adjudication Result Id - Technique to identify that the EOB was not electronic (manual) is through the participation mode code for the adjudicator. May include data centre and sequence numbers | 1 | Mand | code : (ActInvoiceGroupType)  Business name: Invoice Type Invoice Type e.g. Healthcare Services, Rx Dispense, Rx Compound For Invoice (COB) : Invoice type (for root) cannot be different from submitted invoice. This would be a cause for rejecting the invoice. For Adjudication Results: code must match to the corresponding invoice element that was submitted. For Invoice Nullify Results: this is the identifier of the EOB that was previously messaged to the Provider. Modifiers for the codes are taken from the same domain (i.e ActInvoiceGroupCode). | 1 | Mand | statusCode : (ActStatus)  Business name: Invoice Status Codes representing the defined states of an Act as defined by the Act class state machine. Active EOBs are used to convey interim or preliminary adjudication results. They can also be used, with information codes, to indicate that the invoice grouping is held for manual review by the adjudicator, waiting for other third party information (e.g. from another provider, employer, etc.). Suspended EOBs are used to convey adjudication results that are awaiting additional information from the submitting Provider. Complete EOBs are used to convey final adjudication results, with an associated intent to pay. For Invoice (COB): Status code must be complete in order for EOB to be sent to downstream Adjudicators. If a Provider receives a non-complete EOB, this cannot be forwarded to a downstream Adjudicator. Field cannot be made mandatory, as it is not included in Payment Advice Detail messages (only completed EOBs can be included in a Payment Advice). | 1 | Mand | netAmt : MO.CAD  Business name: Paid Amount Paid Amount For Coverage Extension Results, this is typically not specified, as dollar limits are noted as information codes | 1 | Mand | | reason : PaymentIntentReason | 0-1 | Req | | reference : Reference | 0-1 | Req | | referencedBy : AdjudResultsRef | 0-1 | Req |
| FICR_MT630000CA.InvoiceElementGroup  Business name: Invoice Element Group |
|---|
classCode : "INVE" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: Invoice Group ID Set of identifiers that uniquely identify the Invoice Grouping. May include data centre and sequence numbers 1. unique invoice group identifier, independent of adjudicator recipient. 2. sequential invoice grouping identifier by adjudicator. Obligation on adjudicator is to return and communicate about this item with all identifiers (i.e. identifier 1. and 2.). Invoice Grouping Identifier: There are some situations where more than 1 identifier for this object can be included in a message. | 1 | Mand | code : (ActInvoiceGroupType)  Business name: Invoice Type Invoice Type - Health Care Services/Goods, Rx Dispense, Rx compound, Preferred Accom. Invoice Type is the indication to the payor as to the content rules to apply when processing and adjudicating the invoice. Basically, the structure of the invoice grouping. Ie. Clinical Product, Clinical Service, Preferred Accom, Rx Dispense, Rx Compound This is used to indicate the type of Invoice Grouping. Each Invoice Type is used to specify 1. vocabulary, 2. structure of the Invoice Element Choice and 3. which Billable Act(s) can be included for the specified Invoice Type. Information on constraints for the Invoice Type will be found in the NeCST Message Specifications. Each Benefit Group will indicate which Invoice Types will be supported by that Benefit Group. Invoice Types will not generate unique and distinct XML schemas that can tested independent of each other. They must be tested together within an Message Type. | 1 | Mand | netAmt : MO.CAD  Business name: Invoice Sub-total Invoice Sub-total - Identifies the total monetary amount billed for the invoice element. For Cancel Request: This would serve as a cross-check for the Adjudicator for the Invoice Grouping that is being cancelled. Attribute cannot be mandatory as it may not be present for a Coverage Extension Request. This is the sum of the Submitted Invoice Line amounts. | 1 | Mand | | reference : PreviousAdjudicationResultReference | 0-10 | Req |
|
FICR_MT630000CA.PaymentIntent  Business name: Payment Intent Intention of Payor to pay invoice as previously adjudicated. If an Adjudicator adjudicates for multiple insurance policies (EOBs) for multiple Payors and/or Payees, there would be more than 1 Payment Intent payload in the Results message |
|---|
classCode : "XACT" (ActClass) | 1 | Mand | moodCode : "PRMS" (ActMood) | 1 | Mand | effectiveTime : TS.DATE  Business name: Payment Intent Date/Time Parment Intent Date/Time - Time payor intends to make payment (e.g. date of cheque/EFT run). For nullify, this would also be the date the payor intends to make the payment. For Invoice Nullify Results: Effective time of the cancel is noted in the control act wrapper. | 0-1 | Req | amt : MO.CAD  Business name: payment amount payment amount Adjudication Results: The payment intent amount cannot be mandatory for active adjudication results. For Invoice Nullify Results: the payment intent is completed only, and therefore the amount must be specified. For completed Payment Intents, this field is mandatory. Net_amt must be positive or 0 for Adjudication Results messages Net_amt must be negative or 0 for Invoice Cancel messages | 1 | Mand | | credit : PaymentIntentPayee | 0-1 | Req | | debit : PaymentIntentPayor | 0-1 | Req |
| FICR_MT630000CA.PaymentIntentPayee  Business name: Organisation/Individual receiving payment for claim. Organisation/Individual receiving payment for claim. Mandatory for completed EOBs. May not be present for active/suspended EOBs |
|---|
typeCode : "CREDIT" (ActRelationshipType) | 1 | Mand | | account : Account | 1 | Pop |
|
| |
| |
|
|
|
|---|
MCAI_MT700210CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700210CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
| 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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | subject : Subject2 | 1 | Mand | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf1 : Subject3 | 0-1 | Req | | subjectOf2 : Subject | 0-50 | Req | | componentOf : Component | 0-100 | Req |
|
MCAI_MT700210CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| MCAI_MT700210CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
MCAI_MT700210CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| |
| |
MCAI_MT700210CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried according to the dataEnterer.contextControlCode (propogate to the payload and add to any data enterer(s) already present in the payload). 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, modified or removed. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried (to the payload) according to the dataEnterer.contextControlCode (AP = propogate to the payload and add to any data enterer(s) already present in 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, contextConductionInd must be true, otherwise it must be false. | 1 | Mand | act :  | 1 | Mand |
| MCAI_MT700210CA.Subject3  Business name: c:authorized by Information pertaining to a patient's agreement/acceptance to have his/her clinical information electronically stored and shared. This will usually only be populated for queries, but could be used for updates if a jurisdiction requires consent before recording information in the EHR (e.g. consent to participate in electronic data exchange). Note: keywords canot be passed from one application to another via the EHR (e.g. prescriber to dispenser via a Drug Information System). 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 drug utilization processing. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | consentEvent : ConsentEvent | 1 | Pop |
|
|
|
|
|---|
MCAI_MT700211CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700211CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
| 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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | subject : Subject2 | 1 | Mand | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf1 : Subject3 | 0-1 | Req | | subjectOf2 : Subject | 0-50 | Req | | componentOf : Component | 0-100 | Req |
|
MCAI_MT700211CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| MCAI_MT700211CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
MCAI_MT700211CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| |
| |
MCAI_MT700211CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried (to the payload) according to the dataEnterer.contextControlCode (AP = propogate to the payload and add to any data enterer(s) already present in 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. | 1 | Mand | act :  | 1 | Mand |
| MCAI_MT700211CA.Subject3  Business name: c:authorized by Information pertaining to a patient's agreement/acceptance to have his/her clinical information electronically stored and shared. This will usually only be populated for queries, but could be used for updates if a jurisdiction requires consent before recording information in the EHR (e.g. consent to participate in electronic data exchange). Note: keywords canot be passed from one application to another via the EHR (e.g. prescriber to dispenser via a Drug Information System). 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 drug utilization processing. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | consentEvent : ConsentEvent | 1 | Pop |
|
|
|
|
|---|
MCAI_MT700212CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700212CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
MCAI_MT700212CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | subject : Subject2 | 1 | Mand | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf1 : Subject3 | 0-1 | Req | | subjectOf2 : Subject | 0-50 | Req |
| MCAI_MT700212CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700212CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700212CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| MCAI_MT700212CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried (to the payload) according to the dataEnterer.contextControlCode (AP = propogate to the payload and add to any data enterer(s) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
MCAI_MT700212CA.Subject3  Business name: c:authorized by Information pertaining to a patient's agreement/acceptance to have his/her clinical information electronically stored and shared. This will usually only be populated for queries, but could be used for updates if a jurisdiction requires consent before recording information in the EHR (e.g. consent to participate in electronic data exchange). Note: keywords canot be passed from one application to another via the EHR (e.g. prescriber to dispenser via a Drug Information System). 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 drug utilization processing. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | consentEvent : ConsentEvent | 1 | Pop |
|
|
|
|
|---|
MCAI_MT700216CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
| |
MCAI_MT700216CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the payload) according to the subjectOf.contextControlCode (AP = propogate to the payload and add to any subject(s) (issues) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700217CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
| |
MCAI_MT700217CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the payload) according to the subjectOf.contextControlCode (AP = propogate to the payload and add to any subject(s) (issues) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700218CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
MCAI_MT700218CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the payload) according to the subjectOf.contextControlCode (AP = propogate to the payload and add to any subject(s) (issues) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700220CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700220CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | 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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | subject : Subject2 | 1 | Mand | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf : Subject | 0-50 | Req |
| MCAI_MT700220CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700220CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700220CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
| MCAI_MT700220CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried (to the payload) according to the dataEnterer.contextControlCode (AP = propogate to the payload and add to any data enterer(s) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700221CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700221CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | subject : Subject2 | 1 | Mand | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf : Subject | 0-50 | Req |
| MCAI_MT700221CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700221CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700221CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
| MCAI_MT700221CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried (to the payload) according to the dataEnterer.contextControlCode (AP = propogate to the payload and add to any data enterer(s) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700222CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700222CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | subject : Subject2 | 1 | Mand | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf : Subject | 0-50 | Req |
| MCAI_MT700222CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700222CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700222CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| MCAI_MT700222CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the dataEnterer association is carried (to the payload) according to the dataEnterer.contextControlCode (AP = propogate to the payload and add to any data enterer(s) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700226CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
| |
MCAI_MT700226CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the payload) according to the subjectOf.contextControlCode (AP = propogate to the payload and add to any subject(s) (issues) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700227CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
| |
MCAI_MT700227CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. On creation interactions where the state transition is null->active, contextConductionInd must be true, otherwise it must be false. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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. If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value. In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the payload) according to the subjectOf.contextControlCode (AP = propogate to the payload and add to any subject(s) (issues) already present in 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. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700228CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
MCAI_MT700228CA.Subject2  Business name: f:refers to Indicates the item(s) being acted upon by this trigger event. Will be mandatory in wrappers with payload messages, otherwise not present. 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, modified or removed. |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (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, contextConductionInd must be true, otherwise it must be false. | 1 | Mand | act :  | 1 | Mand |
|
|
|
|
|---|
MCAI_MT700230CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700230CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
MCAI_MT700230CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf : Subject | 0-50 | Req |
| MCAI_MT700230CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700230CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700230CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
|
|
|
|
|---|
MCAI_MT700231CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700231CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
MCAI_MT700231CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf : Subject | 0-50 | Req |
| MCAI_MT700231CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700231CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700231CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
|
|
|
|
|---|
MCAI_MT700232CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: 1. 'identified' when supporting Patient Session Tokens. 2. 'informational' when passing through non Client- Registry patient for PHS or similar processing. 3. 'identified-confirmable' otherwise. Critical for auditing and for validating permissions and therefore mandatory. If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise the R_ActingPerson CMET must be specified. |
|---|
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 | | Choice: authorPerson : AuthorPerson | 1 | Mand | | »» authorRole1 : AuthorRole | 0-1 | Opt | | »» Choice: actingPerson : ActingPerson | 0-1 | Opt | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| MCAI_MT700232CA.AuthorizationToken  Business name: Authentication Token Conveys an authentication token associated with the event. The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) Only one of Id or Text must be specified. |
|---|
classCode : "VERIF" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.TOKEN  Business name: Authorization Token as Id An authorization token expressed as a GUID. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. GUIDs are an effective way of conveying a temporary authentication token | 0-1 | Opt | text :  Business name: Authorization Token An authentication token expressed as a non-GUID string. The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Some systems may choose to use a hashcode or other approach to token construction. | 0-1 | Req |
|
MCAI_MT700232CA.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.BUS  Business name: B:Event Identifier A unique identifier for this particular event assigned by the system in which the event occurred. Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. | 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)  Describes the status of the control act, which is always complete (it happened). Required for completeness of specification. | 1 | Mand | effectiveTime : IVL<TS.FULLDATEWITHTIME>  Business name: C:Event Effective Period Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events 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 message interaction (e.g. query, activation request, modification request) 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' or 'reason for accessing information'. | 0-1 | Req | languageCode : CE (HumanLanguage)  Business name: Message Language | 0-1 | Req | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 1 | Mand | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf : Subject | 0-50 | Req |
| MCAI_MT700232CA.DataEnterer  Business name: b:*entered by Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. This should only be specified if different from the author. Important for audit information and determining permissions. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ENT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
MCAI_MT700232CA.DataEntryLocation  Business name: *b1:recorded at Indicates the location where the record of this event was entered. This should only be specified if different from the location where the event was authored. Indicates a potential location for written records, and may also be important for authentication purposes. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MCAI_MT700232CA.Location  Business name: *a1:created at Indicates the service delivery location where the event occurred. Indicates where paper records may be located, and may be important to determining authorization. The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
|