Interactions Report for Version: V01R01.4
Interactions Table of Contents
Package Locations Table of Contents
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record service delivery location accepted |
|---|
Indicates that a service delivery location has been recorded. | | Message<ControlActEvent<Role>> |
|
|
|
|
|---|
| Record service delivery location refused |
|---|
Indicates that the request to record a new service delivery location has been refused. | | Message<ControlActEvent<Role>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Update service delivery location accepted |
|---|
Indicates that the requested service delivery location information has been sucessfully updated. | | Message<ControlActEvent<Role>> |
|
|
|
|
|---|
| Update service delivery location refused |
|---|
Indicates that the requested modification to the service delivery location has been refused. | | Message<ControlActEvent<Role>> |
|
|
|
|
|---|
| Patient health condition summaries query |
|---|
Request retrieval of the list of recorded patient health conditions (symptoms, health problems, diagnosis). Including past changes. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Patient health condition details query |
|---|
Request retrieval details of a patient health conditions (symptoms, health problems, diagnosis). Including past changes. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record health condition request accepted |
|---|
Indicates that the requested health condition record has been successfully added to the patient's record. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record health condition request refused |
|---|
Indicates that the request to add the specified health condition to the patient record has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Update health condition request |
|---|
Requests that information such as severity, status, start date and end date of a previously-recorded health condition be updated. | | Message<ControlActEvent<ConditionEvent>> |
|
|
|
|
|---|
| Update health condition request accepted |
|---|
Indicates that the requested severity, status, start date, end date or other information about a previously-recorded medical condition has been successfully updated. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Update health condition request refused |
|---|
Indicates that the requested modification to the previously-recorded health condition has been refused. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record patient prof. service request accepted |
|---|
Indicates that a record of a professional service which has been delivered to a patient has been successfully added. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record patient prof. service request refused |
|---|
Indicates that the request to add a record of a professional service which has been delivered to a patient has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Record patient measurement obs. request |
|---|
Requests that a measurement observation (for example are: height, weight, blood-pressure, temperature) be recorded in a patient's record. | | Message<ControlActEvent<CommonObservationEvent>> |
|
|
|
|
|---|
| Record patient measurement obs. request accepted |
|---|
Indicates that the requested measurement observation (for example are: height, weight, blood-pressure, temperature) has been successfully recorded in a patient's record. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record patient measurement obs. request refused |
|---|
Indicates that the request to record the specified measurement observation (for example are: height, weight, blood-pressure, temperature) in the patient's record has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Patient measurement observations query |
|---|
Requests retrieval of the measurement observations which have been recorded for a particular patient, optionally filtered by the type of observation and/or by the date-range for which the observation was recorded. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record patient coded observation request accepted |
|---|
Indicates that the requested coded observation (for example: APGAR score, symptom, blood type, smoker, etc.) has been successfully recorded in a patient's record. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record patient coded observation request refused |
|---|
Indicates that the request to record the specified coded observation (for example: APGAR score, symptom, blood type, smoker, etc.) in the patient's record has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Patient coded observations query |
|---|
Requests retrieval of the coded observations which have been recorded for a particular patient, optionally filtered by the type of observation and/or by the date-range for which the observation was recorded. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record care composition request accepted |
|---|
Indicates that a record about an encounter, episode or similar structure for a particular patient or group of patients has been successfully added. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record care composition request refused |
|---|
Indicates request to record basic information about an encounter, episode or similar structure for a particular patient or group of patients has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
| Update care composition request accepted |
|---|
A modification of encounter, episode or similar data for a particular patient or group of patients, has been successfully added. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Update care composition request refused |
|---|
Indicates request to record a modification of encounter, episode or similar data for a particular patient or group of patients, has been refused. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record discharge/ care summary request refused |
|---|
Indicates that the request to record a Discharge/Care Summary has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
|
|
|
|
|---|
| Record clinical observation doc. request accepted |
|---|
Indicates that a clinical observation document about a patient has been recorded. | | Message<ControlActEvent<ActRequest>> |
|
|
|
|
|---|
| Record clinical observation doc. request refused |
|---|
Indicates that the request to record a clinical observation document about a patient has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Patient referral summaries query |
|---|
Requests retrieval of referrals for a particular patient, potentially filtered by time or other criteria. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Patient discharge / care summaries query |
|---|
Requests retrieval of Discharge/ Care Summaries for a particular patient, potentially filtered by time or other criteria. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Patient discharge / care summaries query response |
|---|
Returns a list of Discharge/ Care Summaries for a particular patient, potentially filtered by time or other criteria. | | Message<ControlActEvent<Document, ParameterList>> |
|
|
|
|
|---|
| Patient clinical observation doc. summaries query |
|---|
Requests retrieval of a list of available clinical observation documents for a particular patient, potentially filtered by type of note. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Patient clinical obs. doc summaries query response |
|---|
Returns a list of available clinical observation documents for a particular patient, potentially filtered by type of note. | | Message<ControlActEvent<Document, ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Patient clinical observation doc. details query |
|---|
Requests retrieval of Clinical Observation Document details for a particular patient, potentially filtered by time or other criteria. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
| Patient clinical observation doc detail query resp |
|---|
Returns a list of Clinical Observation Document details for a particular patient, potentially filtered by time or other criteria. | | Message<ControlActEvent<Document, ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
|
|
|
|
|---|
| Record referral request refused |
|---|
Indicates that the request to record a referral (to a provider or organization) has been refused. | | Message<ControlActEvent> |
|
|
|
|
|---|
| Patient care composition details query |
|---|
Requests retrieval of details of an encounter, episode and similar structures for a particular patient or group of patients, potentially filtered by date or other criteria. | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
| Patient care composition summaries query |
|---|
Requests retrieval of a list of encounters, episodes and similar structures for a particular patient or group of patients, potentially filtered by date or other criteria. <p/> | | Message<ControlActEvent<ParameterList>> |
|
|
|
|
|---|
|
|
|
|
|---|
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, and is therefore mandatory IMMUNIZATION INTERPRETATION.REFERENCED DATA | 1 | Mand | 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 |
|
|
|
|
|---|
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 : (OtherIdentifierRoleType)  Business name: J:Other Identifier Type Describes the identification type (driver's license, etc.) Used to set the type of identier | 1 | Mand |
| 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 : (LogicalObservationIdentifierNamesAndCodes)  Business name: Identifying Charateristics Observation Type Describes the observation type. For this usage, the observation type is fixed to LOINC code "10186-5" Used to categorize this observation event. For this model, the observation is a description of patient characteristics used for identification. invariant( x) { code.code = 10186-5 code.codeSystemName = LOINC; } | 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 : II.BUS  Business name: A:Patient Identifier | 1 | 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 : II.TOKEN  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. C39 (Extension) PTT.050.01 (Extension) PTT.050.02 (Root) A.1 PID.2 Patient.332-CY (Extension) Patient.331-CX (Root) Claim.330-CW Health Card Number PID.2 PID.4 ZDU.2 ZKW.3 Jurisdiction (Root) Person.PHN (Extension) | 1 | Mand |
|
|
|
|
|---|
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 : 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. C39 (Extension) PTT.050.01 (Extension) PTT.050.02 (Root) A.1 PID.2 Patient.332-CY (Extension) Patient.331-CX (Root) Claim.330-CW Health Card Number PID.2 PID.4 ZDU.2 ZKW.3 Jurisdiction (Root) Person.PHN (Extension) | 1 | Mand | | patientPerson : Person | 1 | Mand |
| | COCT_MT050202CA.Person |
|---|
classCode : "PSN" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name : PN.BASIC  Business name: B:Patient Name The name by which the patient is known 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 | Mand | 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 : 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'. 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 | 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 : 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. C39 (Extension) PTT.050.01 (Extension) PTT.050.02 (Root) A.1 PID.2 Patient.332-CY (Extension) Patient.331-CX (Root) Claim.330-CW Health Card Number PID.2 PID.4 ZDU.2 ZKW.3 Jurisdiction (Root) Person.PHN (Extension) | 1 | Mand | addr : AD.BASIC  Business name: C:Patient Contact Address Physical address for the patient where they may be visited or found. 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 | Mand | 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_MT080100CA.Container  Business name: Specimen Container The container holding the specimen. Used to document container risks to those who handle the container. |
|---|
classCode : "CONT" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | riskCode : (EntityRisk)  Business name: Y:Specimen Container Risk Describes any risk to the handlers of this container (containing a specimen). Used to document container risks to those who handle the container. | 1 | Pop |
| 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 : (SpecimenTypeCode)  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 : (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) | 1 | Mand | | specimenMaterial : Material | 1 | Mand | | subjectOf1 : Subject3 | 0-10 | Req | | subjectOf2 : Subject4 | 0-100 | 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.FULLDATETIME>  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 | | performer : Performer2 | 0-1 | Req | | subjectOf : Subject2 | 0-10 | Req |
| COCT_MT080100CA.SpecimenObservationEvent  Business name: Specimen Observation One or more observation acts which describe aspects of a specimen (color, adequacy, etc.) It is sometimes relevant to know certain specimen characteristics when evaluating a result regarding a specimen. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (SpecimenObservationCode)  Business name: Specimen Observation Type Describes the specific observation being performed/documented. Type of observation. | 1 | Mand | effectiveTime : IVL<TS.FULLDATETIME>  Business name: Specimen Observation Date/Time When this observation took place (or over what time interval; for collection). The date/time when the observation took place. The date and time of the specimen observation can be relevant in the result. | 0-1 | Req | value : ANY.X1  Business name: Specimen Observation Value | 1 | Mand |
|
| COCT_MT080100CA.Subject3  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.Subject4  Business name: has subject observations Associates a specimen (role) with observations about that specimen Used to communicate specimen characteristics such as color, adequacy, etc. |
|---|
typeCode : "SBJ" (ParticipationType) | 1 | Mand | | specimenObservationEvent : SpecimenObservationEvent | 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 : (ActSpecimenTransportationCode)  Business name: P:Transportation Type Describes the type of process step being documented and communicated e.g. specimen received data, specimen action codes, transportation type. 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 : 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 | 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 | Mand | | 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 : 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 | 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 | 1 | Mand |
|
|
|
|
|
|---|
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_MT120402CA.ObservationCondition  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 : (ActCode)  Business name: Diagnosis Type Identifies the type of condition described (diagnosis or indication) Identifies this measurement as a type of diagnosis and is therefore mandatory. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | value : CD (DiagnosisValue)  Business name: A:Diagnosis Code A coded form of the diagnosis 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.TOKEN  Business name: B:Change Identifier A unique identifier for this particular change. Allows referencing (and potentially undoing) a specific change. Every status change has an identifier, thus this attribute is mandatory. | 1 | Mand | code : (HL7TriggerEventCode)  Business name: A:Change Type Identifies what kind of change occurred. This attribute is mandatory to ensure that change types are distinguishable. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE>  Business name: C:Change Effective Date and End Date The date on which the various changes of an event become valid and applicable and potentially when the change is supposed to cease. Allows applications to sort and filter by time. The date on which a change is effective should always be known and thus is mandatory. The end date may be left unspecified if there isn't a specific targetted end date (e.g. with a suspend including a planned release date). | 1 | Mand | reasonCode : (ControlActReason)  Business name: D:Change Reason Denotes the reason the record was modified. Ensures consistent terminology in capturing and interpreting reasons for change. Allows CWE because not all reasons will correspond to a pre-defined code. | 0-1 | Req | | author : Author3 | 1 | Mand |
|
|
|
|
|---|
COCT_MT141007CA.ClinicalDevice  Business name: Device A catalog of devices (manufactured material) from which devices may be selected for prescribing/dispensing. Provides a list of devices available for prescribing/dispensing. A_BillablePharmacyDispense |
|---|
classCode : "DEV" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ClinicalDeviceEntity)  Business name: A:Device Code An identifier for a type of device. Used to ensure clear communication by uniquely identifying a particular device product when prescribing or dispensing. This attribute is only marked as 'populated' because some devices will not have codes associated with them. | 1 | Pop | name :  Business name: B:Device Name The name assigned to a type of device. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. | 1 | Mand | desc :  Business name: C:Device Description A free form textual description of a device and its characteristics (e.g. size, shape, etc.). This is used when additional information must be conveyed that is not apparent by just specifying code and name. Allows description of characteristics of the device not necessarily conveyed by the code or name. | 0-1 | Req | | asContent : Content | 0-1 | Req |
| COCT_MT141007CA.Content  Business name: packaged in Information about how the device is packaged. May influence prescribing quantities. |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | quantity : INT.POS  Business name: F:Device Package Quantity The quantity of devices contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. Attribute is marked as "mandatory" to ensure that quantity in a package is always known. | 1 | Mand | | containerPackagedDevice : PackagedDevice | 1 | Mand |
|
COCT_MT141007CA.ManufacturedProduct  Business name: Device Product A medical device product intended to be supplied and/or used by a patient. Encompasses supplies, aids, etc. Allows devices to be clearly described and referenced. Also allows searching for and examining information about devices that can be or are being used by a patient. A_BillablePharmacyDispense |
|---|
classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturedClinicalDevice : ClinicalDevice | 1 | Mand |
| COCT_MT141007CA.PackagedDevice  Business name: Device Package Describes the container in which a device can be or should be provided to the patient. Used for informing dispenser of the need and authorization to dispense device in a clinically approved container. Aids patients in adhering to usage instructions. May also influence the quantity prescribed. The empty class is mandatory for HL7 alignment and modeling reasons. |
|---|
classCode : "CONT" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 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 : (ClinicalDrug)  Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccines), generic formulation, generic, therapeutic class, etc. Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name :  Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc :  Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | formCode : (OrderableDrugForm)  | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220100CA.Substance  Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType)  Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as class of ingredients in a vaccine. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name :  Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
COCT_MT220110CA.Content  Business name: dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package Quantity and Drug Container Type |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG  Business name: F:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220110CA.Ingredient  Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
classCode : "INGR" (RoleClass) | 1 | Mand | negationInd :  Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is 'populated' because the distinction between "does/must contain" and "does/must not contain" is essential, however in some circumstances it is necessary to say "may contain". | 1 | Pop | quantity : PQ.DRUG  Business name: C:Drug Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | Mand |
|
COCT_MT220110CA.ManufacturedProduct  Business name: manufactured by Associates a drug product with the organization responsible for producing it. May be important for tracing adverse events and for performing drug searches. |
|---|
classCode : "MANU" (RoleClass) | 1 | Mand | | manufacturer : Manufacturer | 1 | Mand |
| COCT_MT220110CA.Manufacturer  Business name: Manufacturer Identity of the organization that manufactured the drug product. Useful in distinguishing and grouping drug products |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.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 : (ClinicalDrug)  Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccines), generic formulation, generic, therapeutic class, etc. Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name :  Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc :  Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | formCode : (OrderableDrugForm)  | 0-1 | Req | | asManufacturedProduct : ManufacturedProduct | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220110CA.Substance  Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType)  Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as class of ingredients in a vaccine. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name :  Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
COCT_MT220200CA.Content  Business name: drug dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package Quantity and Drug Container Type. |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG  Business name: B:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220200CA.Ingredient  Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
classCode : "INGR" (RoleClass) | 1 | Mand | negationInd :  Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is '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 : (ManufacturedDrug)  Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccine). Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers. Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name :  Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc :  Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | formCode : (OrderableDrugForm)  | 0-1 | Req | lotNumberText :  Business name: E:Drug Lot Number Identification of a batch in which a specific manufactured drug belongs. Useful in tracking for recalls but may not always exist. X0301 RXA.15 C.6 | 0-1 | Req | expirationTime : IVL.HIGH<TS.FULLDATE>  Business name: F:Drug Expiry Date Indicates either the length of time a drug product can remain viable (when talking about a drug in general terms), or the date on which the drug product is no longer considered viable (when talking about a specific medication that has been dispensed). To indicate the length of time after opening a product remains viable, specify the 'Width' property. To indicate a specific end date for an actual dispensed product, specify the 'High' property The potency, effectiveness and safety of drug products changes over time. When determining quantities to be supplied to a patient, one of the considerations is how long the drug will remain viable. DispensedItem.expiryDate Drug Expiry Date C7 | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220200CA.Substance  Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType)  Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as specific class of ingredients in vaccines. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name :  Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
COCT_MT220210CA.Content  Business name: drug dispensed in Information about how the dispensed drug is or should be contained May influence prescribing quantities, and also allows conveying instructions with respect to special packaging such as compliance packaging. A_BillablePharmacyDispense Must specify at least one of Drug Package Quantity and Drug Container Type. |
|---|
classCode : "CONT" (RoleClass) | 1 | Mand | quantity : PQ.DRUG  Business name: B:Drug Package Quantity The quantity of the medication dosage form contained in the package given or to be given to the patient. Sometimes ordering and dispensing is by package rather than individual units, and package is important in calculating total amount supplied. ZDP.10.2.2 ZDP.9.2.2 | 0-1 | Req | | containerPackagedMedicine : PackagedMedicine | 0-1 | Req |
| COCT_MT220210CA.Ingredient  Business name: drug contains Identification of which ingredients are contained (or are not contained) in a drug, along with their respective quantities. Useful to providers in deciding appropriate use instruction (dosage specification) for patients. Also important in checking for potential adverse reactions to non-active ingredients. For compounds, allows contraindication checking against ingredients of custom compounds. |
|---|
classCode : "INGR" (RoleClass) | 1 | Mand | negationInd :  Business name: D:Drug Does Not Contain Indicator An indication that a drug does not contain the specified ingredient (active or inactive). Useful for filtering searches. Allows providers to search for drugs not containing a specific active ingredients or excipients. E.g. lactose-free, gluten-free, etc. The attribute is 'populated' because the distinction between "does/must contain" and "does/must not contain" is essential, however in some circumstances it is necessary to say "may contain". | 1 | Pop | quantity : PQ.DRUG  Business name: C:Drug Ingredient Quantity The quantity of the ingredient in a drug. This is represented/measured in various forms/units including: mg, mg/vol, %, etc. Essential for evaluating appropriate dosage based on strength, as well as for creating custom compounds with proper composition. CompoundIngredient.amount(numerator) CompoundIngredient.proportionOfFinal(e.g. 10% = .1mg/1mg) ZPC.4(quantity) ZPC.5(unit) ZPJ1.4(quantity) ZPJ1.5(unit) ZPJ1.6(e.g. 10% = .1mg/1mg) ZCP.3 ZDU.4.3 ZDU.6.1.2 Compound.448-ED (quantity) Compound.451-EG (unit) | 0-1 | Req | | ingredient : Substance | 1 | 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 : (ManufacturedDrug)  Business name: A:Drug Code An identifier for a type of drug. Depending on where the drug is being referenced, the drug may be identified at different levels of abstraction. E.g. Manufactured drug (including vaccine). Used to ensure clear communication by uniquely identifying a particular drug product when prescribing or dispensing. This attribute is only marked as 'populated' because some custom compounds will not have unique identifiers. Datatype has been retained as CE (Translatable Code) to support translation between multiple code sets for drugs (e.g. DIN, GTIN, UPC). DrugProduct.activeIngredientId DrugProduct.ActiveIngredientGroupNumber DrugProduct.DIN DrugProduct.StandardProductId (Mnemonic) DrugProduct.StandardIDType(Code System) D56(use code system to distinguish different types) ZPB2.1 ZPB3.1 ZPC.1 ZPC1.3 ZPD.1 ZPD1.1 ZPD.6(scoping a specialized kind of therapeutic equivalent) MB.05.03B ZPS.11 ZDP.3a(code system) ZDU.4.1 ZDP.7 DRU.010-03(mnemonic) DRU.010-04(code system) DRU.010-08(mnemonic) DRU.010-09(code system) DRU.100-04 (mnemonic) DRU.100-05 (code system) Compound.488-RE (code system) Compound.489-TE (mnemonic) DUR/PPS.475-J9 (code system) DUR/PPS.476-H6 (mnemonic) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.453-EJ (code system) Claim.445-EA (mnemonic) Claim.406-D6 (determined from code system) RXA.5 A_BillablePharmacyDispense | 1 | Pop | name :  Business name: B:Drug Name The name assigned to a drug. First occurrence is preferred for display. Names are used for human reference communication, to allow selection from dropdowns and for local searching. If a code is available, the name acts as a cross-check. If the code is not available the name acts as the primary identifier. The attribute is therefore mandatory. DrugProduct.Name (Search) CoumpoundDrugProduct.name Contraindication.interactingDrugName DrugProduct.labelName(useCode=L) ZPB2.2 ZPB3.2 ZPC.2 ZPD.2 ZPD1.2 ZPD.5 MB.01.03 Drug Name ZDU.4.2 ZDU.6.1.1 DRU.010-02 RXA.TradeName DRU.010-10->12 Brand Name C.1a Trade Name Other Name | 1 | Mand | desc :  Business name: C:Drug Description A free form textual description of a drug. This usually is only populated for custom compounds, providing instructions on the composition and creation of the compound. Allows description of compound ingredients and/or recipe in free text form. DrugProduct.description CompoundedDrugProduct.adhocSpecification DRU.010-06 DIN Description | 0-1 | Req | formCode : (OrderableDrugForm)  | 0-1 | Req | lotNumberText :  Business name: E:Drug Lot Number Identification of a batch in which a specific manufactured drug belongs. Useful in tracking for recalls but may not always exist. X0301 RXA.15 C.6 | 0-1 | Req | expirationTime : IVL.HIGH<TS.FULLDATE>  Business name: F:Drug Expiry Date Indicates either the length of time a drug product can remain viable (when talking about a drug in general terms), or the date on which the drug product is no longer considered viable (when talking about a specific medication that has been dispensed). To indicate the length of time after opening a product remains viable, specify the 'Width' property. To indicate a specific end date for an actual dispensed product, specify the 'High' property The potency, effectiveness and safety of drug products changes over time. When determining quantities to be supplied to a patient, one of the considerations is how long the drug will remain viable. DispensedItem.expiryDate Drug Expiry Date C7 | 0-1 | Req | | asManufacturedProduct : ManufacturedProduct | 0-1 | Req | | asContent : Content | 0-1 | Req | | ingredient : Ingredient | 0-10 | Req |
|
| COCT_MT220210CA.Substance  Business name: Drug Ingredients A list of drugs, chemicals or excipients that may or may not be present in a manufactured drug or a custom compound. Important for expressing strength of active ingredients within a drug product, for expressing compound recipes, and for identifying potential causes for adverse reactions. Must specify at least one of Drug Ingredient Identifier and Drug Ingredient Name |
|---|
classCode : "MMAT" (EntityClass) | 1 | Mand | determinerCode : "KIND" (EntityDeterminer) | 1 | Mand | code : (ActiveIngredientDrugEntityType)  Business name: A:Drug Ingredient Identifier The unique identifier for the drug or chemical. Allows un-ambiguous identification of the ingredients of a drug for performing various alert checking. Also allows for the identification of antigens as specific class of ingredients in vaccines. CompoundIngredient.IngredientDrug.activeIngredientCode CompoundIngredient.IngredientDrug.DIN CompoundIngredient.IngredientDrug.hcAigNumber CompoundIngredient.IngredientDrug.standardProductId(mnemonic) CompoundIngredient.IngredientDrug.standardProductIdType(code system) ZPB3.6(mnemonic) ZPB3.7(print name) ZPJ1.1(mnemonic) ZPJ1.2(print name) ZCP.2 | 0-1 | Req | name :  Business name: B:Drug Ingredient Name The name of the contained drug or chemical. Used for communication between and display to providers. CompoundIngredient.IngredientDrug.drugProductName | 0-1 | Req |
|
|
|
|
|---|
| COCT_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_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 | | 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. The attribute is marked as populated because it may be masked. | 1 | Pop | code : (ObservationIssueTriggerCodedObservationType)  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 : (x_VeryBasicConfidentialityKind)  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-1 | 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. The attribute is marked as populated because it may be masked. | 1 | Pop | code : (ObservationIssueTriggerMeasuredObservationType)  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 : (x_VeryBasicConfidentialityKind)  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-1 | 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.Organization |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C:Knowledgebase Vendor Name The name of a clinical knowledgebase vendor organization. Allows a knowledgebase vendor to be referenced by name. The attribute is mandatory because it is the only information collected about a knowledgebase vendor. | 1 | Mand |
| 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. The attribute is marked as populated because it may be masked. 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 : (x_VeryBasicConfidentialityKind)  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-1 | 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. The attribute is marked as populated because it may be masked. | 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 : (x_VeryBasicConfidentialityKind)  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-1 | 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 | | 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_MT260020CA.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_MT260020CA.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_MT260020CA.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 caon pre-coordinate some 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_MT260020CA.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_MT260020CA.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 | | subject : Subject2 | 0-25 | Req | | instantiation : Definition | 0-1 | Req | | mitigatedBy : Mitigates | 0-25 | Req | | triggerFor : Trigger2 | 0-1 | Req | | subjectOf1 : Subject3 | 0-1 | Req | | subjectOf2 : Subject | 1 | Mand |
| COCT_MT260020CA.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_MT260020CA.Location  Business name: *b:dispensed at Indicates the facility where the implicated dispense event was performed Used for contacting the pharmacy or pharmacist involved in the dispense. The association is only marked as 'populated' because it may be masked. A_DetectedMedicationIssue |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
COCT_MT260020CA.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. The attribute is only marked as 'populated' because it may be masked. | 1 | Pop | code : (ObservationIssueTriggerCodedObservationType)  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 : (x_VeryBasicConfidentialityKind)  Business name: D:Observation Masked Indicator An indication of sensitivity surrounding the implicated condition, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the observation. 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-1 | 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 implicated 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_MT260020CA.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 attribute is mandatory 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_MT260020CA.ObservationMeasurableEvent  Business name: Patient Measurable Observations This is the recorded observation (e.g. allergy, medical condition, lab result, weight, 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 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. The attribute is only marked as 'populated' because it may be masked. | 1 | Pop | code : (ObservationIssueTriggerMeasuredObservationType)  Business name: B:Observation Type Distinguishes between the kinds of measurable observations that can trigger clinical issues. 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 : (x_VeryBasicConfidentialityKind)  Business name: D:Observation Masked Indicator An indication of sensitivity surrounding the offending measurable observation, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the observation. 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-1 | Opt | value : PQ.BASIC  Business name: C:Observation Value Denotes a specific measurable observation made about a person that triggered the clinical issue detection. Provides unambiguous reference to the implicated measurable observation. | 0-1 | Req |
| | COCT_MT260020CA.Organization |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C:Knowledgebase Vendor Name The name of a clinical knowledgebase vendor organization. Allows a knowledgebase vendor to be referenced by name. The attribute is mandatory because it is the only information collected about a knowledgebase vendor. | 1 | Mand |
|
COCT_MT260020CA.Product  Business name: *a:dispensed Indicates the implicated drug that was dispensed. Important information for issue management. The association is only marked as 'populated' because it may be masked. |
|---|
typeCode : "PRD" (ParticipationType) | 1 | Mand | | medication : Medication | 1 | Pop |
| COCT_MT260020CA.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 issues must be managed and how. This attribute is marked as "mandatory" because the code denoting 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_MT260020CA.StorageIntent  Business name: Persistent Indicator Indicates that this issue will be persisted as part of the patient's record. Some issues are transitory and are only relevant while a request is being made. Others are relevant for clinical communication and need to be made available after the fact. When deciding whether and how to manage an issue, it is important to recognize which category it fits within. This element behaves as a mandatory boolean where the presence of the association indicates true and the absence of the association indicates false. |
|---|
classCode : "STORE" (ActClass) | 1 | Mand | moodCode : "INT" (ActMood) | 1 | Mand |
| |
| |
COCT_MT260020CA.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 implicated 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 The attribute is only marked as 'populated' because it may be masked. 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 : (x_VeryBasicConfidentialityKind)  Business name: E:Active Medication Masking Indicator An indication of sensitivity surrounding the implicated drug, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the drug. The attribute is optional because not all systems will support masking. | 0-1 | 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_MT260020CA.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, weight classes, etc. 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_MT260020CA.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 dispense 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. The attribute is only marked as 'populated' because it may be masked. | 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 dispensed 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 : (x_VeryBasicConfidentialityKind)  Business name: C:Dispense Masked Indicator An indication of sensitivity surrounding the implicated drug, and thus defines the required sensitivity for the detected issue. Conveys the patient's wishes relating to the sensitivity of the drug. The attribute is optional because not all systems will support masking. | 0-1 | Opt | | product : Product | 1 | Pop | | location : Location | 1 | Pop |
| COCT_MT260020CA.Trigger2  Business name: C:Management Required? Information that indicates whether or not a detected issue needs to be managed. Lets applications distinguish between minor issues that require no management versus those that need management to successfully process the request. The association behaves as a mandatory attribute where the presence of the association indicates 'true', while the absence of indicates 'false'. Contraindication.ManagementRequired (True, if this association is present) |
|---|
typeCode : "TRIG" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | actRequest : ActRequest | 1 | Pop |
|
|
|
|
|---|
| 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 | | 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_MT260022CA.Trigger2  Business name: C:Management Required? Information that indicates whether or not a detected issue needs to be managed. Lets applications distinguish between minor issues that require no management versus those that need management to successfully process the request. The association behaves as a mandatory attribute where the presence of the association indicates 'true', while the absence of indicates 'false'. Contraindication.ManagementRequired (True, if this association is present) |
|---|
typeCode : "TRIG" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | actRequest : ActRequest | 1 | Pop |
|
|
|
|
|---|
| 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.REF  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 | | 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. The attribute is marked as populated because it may be masked. | 1 | Pop | code : (ObservationIssueTriggerCodedObservationType)  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 : (x_VeryBasicConfidentialityKind)  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-1 | 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. The attribute is marked as populated because it may be masked. | 1 | Pop | code : (ObservationIssueTriggerMeasuredObservationType)  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 : (x_VeryBasicConfidentialityKind)  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-1 | 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.Organization |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C:Knowledgebase Vendor Name The name of a clinical knowledgebase vendor organization. Allows a knowledgebase vendor to be referenced by name. The attribute is mandatory because it is the only information collected about a knowledgebase vendor. | 1 | Mand |
| 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_ActMoodOrderEvent)  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. The attribute is marked as populated because it may be masked. 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 : (x_VeryBasicConfidentialityKind)  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-1 | 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. The attribute is marked as populated because it may be masked. | 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 : (x_VeryBasicConfidentialityKind)  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-1 | 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. routeCode is mandatory and apporachSiteCode is required if not using SNOMED - 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 |
|---|
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. | 1 | Mand | code : CD (ActCode)  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 | 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 | 0-1 | Opt | 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 | 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. - 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 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. | 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. - 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.; } |
|---|
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. | 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_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 : ED.SIGNATURE  Business name: Keyword Indicates the keyword appropriate to the action being performed by the message. Allows providers who know the keyword to access information protected by patient keywords. | 0-1 | Req | | personalRelationship : PersonalRelationship | 1 | Pop |
|
COCT_MT470002CA.Author2  Business name: c:consent overridden by Indicates that information access was approved by a provider rather than a patient. I.e. This is an override rather than an actual consent, and is used for the purposes of 'breaking the glass' only. Clinical circumstances may demand that a patient's information be accessed without consent to ensure patient safety. Authorization.signatory(PROV) |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | assignedEntity : AssignedEntity | 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. If author1 (provider) is specified, reason code 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 : "INF" (ActCode)  | 1 | Mand | effectiveTime : IVL<TS.FULLDATE>  Business name: C:Consent Effective and End Time Indicates the time that the consent will expire. 'Low' is effective time and 'High' is end time. Most consents are not open-ended, to ensure the patient retains a level of control. Authorization.endTime (high) | 0-1 | Req | reasonCode : (ActConsentInformationAccessReason)  Business name: E:Consent Override Reason Indicates a reason for overriding a patient's consent rules. Important for audit purposes Authorization.reason (mnemonic) Authorization.comment (original text) | 0-1 | Req | | subject1 : Subject | 1 | Mand | | author1 : Author2 | 0-1 | Req | | author2 : Author | 0-1 | Req | | subject2 : Subject2 | 1 | Mand |
|
| COCT_MT470002CA.Receiver  Business name: *consent given to Identifies the beneficiary of the consent as being a Provider or Service Location. Indicates who is receiving consent to view information. This participation is marked as "populated" as receiver must be specified when keyword is involved. |
|---|
typeCode : "RCV" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | Choice: recipient : Recipient | 1 | Pop | | »» assignedEntity : AssignedEntity | 0-1 | Opt | | »» serviceDeliveryLocation : ServiceDeliveryLocation | 0-1 | Opt |
|
| |
| | COCT_MT470002CA.Subject3 |
|---|
typeCode : "SUBJ" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | actDefinition : ActDefinition | 1 | Mand |
|
|
|
|
|---|
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.Position  Business name: Geographic Coordinates Allows the capturing of a physical location according to a particular coordinate system, such as GPS, legal designation (lot, block, plan), range-meridian, etc. Some locations cannot be described by postal addresses. Also, geographic coordinates allow calculation of distances and proximity |
|---|
classCode : "POS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (PositionObservationCode)  Business name: Coordinate System Identifies the coordinate system inclusive of any transformation projections. Essential for interpretting the specified coordinates and therefore mandatory | 1 | Mand | | component : Component1 | 1-5 | 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 : (PositionCoordinateObservationCode)  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_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.BUS_AND_VER>  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 |
|
|
|
|
|---|
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: Critical for auditing and for validating permissions and therefore mandatory. |
|---|
typeCode : "AUT" (ParticipationType)  Value should always be AUT | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: D:Time of Creation The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.) This date can be back-dated. The time a change is made is a critical piece of audit information and is therefore mandatory. | 1 | Mand | modeCode : (ParticipationMode)  Business name: F:Information Received Method Indicates how the person who recorded the event became aware of it.. E.g. Verbal, written, fax, etc. May have ramifications for the audit trail and reliability of the information. | 0-1 | Req | signatureText : ED.SIGNATURE  Business name: G:Digital Signature Indicates the formal digital signature of the message content. Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. | 0-1 | Opt | | Choice: authorPerson : AuthorPerson | 1 | Pop | | »» 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.AuthorRole  Business name: Null Author Role This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token. |
|---|
classCode : (RoleClass) | 1 | Mand |
| 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. |
|---|
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.Component  Business name: Care Compositions A care composition is a record, which summarizes the events that happened during care including who is responsible for the care provided. Examples include encounters, health condition (episode)-based collections and general care-based collections such as "gynecological care". Allows linking records to encounters, condition and care-based compositions. Useful for searching and navigation of the patient's record. |
|---|
typeCode : (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd :  | 1 | Mand | | patientCareProvisionEvent : PatientCareProvisionEvent | 1 | Pop |
| 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.FULLDATE>  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 | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 0-1 | Opt | | 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 : Subject | 0-50 | Req | | subjectOf2 : Subject3 | 0-1 | 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. |
|---|
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. |
|---|
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. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| MCAI_MT700210CA.RecordTarget  Associated patient record for which this message applies. Record target can be one of either identified patient (id, name, gender, date of birth), indeterminate patient (name, gender, date of birth) or a patient token (suggesting client identity). Inferring patient identity opens up the potential for privacy breach through the mis-keying of identifiers. Also, inclusion of patient identity simplifies logging, processing and application of data access constraints such as masking and consent. Finally, patient id is required to support both EHR Index (record and update) and Patient Profile Summary query (list). Patient identity is key to successful operation of the EHR. A bare identifier exposes the patient to potential privacy violation. |
|---|
typeCode : (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: patient1 : Patient | 1 | Mand | | »» patient1 : Patient | 0-1 | Opt | | »» patient2 : Patient | 0-1 | Opt | | »» patient3 : Patient | 0-1 | Opt |
|
| |
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 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_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_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). 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.FULLDATE>  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 | | recordTarget : RecordTarget | 1 | Mand | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
MCAI_MT700226CA.RecordTarget  Associated patient record for which this message applies. Record target can be one of either identified patient (id, name, gender, date of birth), indeterminate patient (name, gender, date of birth) or a patient token (suggesting client identity). Inferring patient identity opens up the potential for privacy breach through the mis-keying of identifiers. Also, inclusion of patient identity simplifies logging, processing and application of data access constraints such as masking and consent. Finally, patient id is required to support both EHR Index (record and update) and Patient Profile Summary query (list). Patient identity is key to successful operation of the EHR. A bare identifier exposes the patient to potential privacy violation. |
|---|
typeCode : (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: patient1 : Patient | 1 | Mand | | »» patient1 : Patient | 0-1 | Opt | | »» patient2 : Patient | 0-1 | Opt | | »» patient3 : Patient | 0-1 | Opt |
| |
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. |
|---|
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_MT700236CA.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.FULLDATE>  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 | | participant : RecordTarget | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
MCAI_MT700236CA.RecordTarget  Associated patient record for which this message applies. Record target can be one of either identified patient (id, name, gender, date of birth), indeterminate patient (name, gender, date of birth) or a patient token (suggesting client identity). Inferring patient identity opens up the potential for privacy breach through the mis-keying of identifiers. Also, inclusion of patient identity simplifies logging, processing and application of data access constraints such as masking and consent. Finally, patient id is required to support both EHR Index (record and update) and Patient Profile Summary query (list). Patient identity is key to successful operation of the EHR. A bare identifier exposes the patient to potential privacy violation. |
|---|
typeCode : (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: patient1 : Patient | 1 | Mand | | »» patient1 : Patient | 0-1 | Opt | | »» patient2 : Patient | 0-1 | Opt | | »» patient3 : Patient | 0-1 | Opt |
| |
|
|
|
|---|
| |
| MCCI_MT002100CA.AttentionLine  Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText :  Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value :  Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
|
| MCCI_MT002100CA.Device1 |
|---|
classCode : "DEV" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: IA:Sending Application Identifier The unique identifier of the application or system from where the message is being sent. Because this is the key identifier of where the message is coming from, this attribute is mandatory. | 1 | Mand | name :  Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc :  Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE>  Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName :  Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName :  Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
| |
MCCI_MT002100CA.Device3  Business name: Respond To System The system to which responses are to be directed. Provides support for directing responses to applications other than the original sender. |
|---|
classCode : "DEV" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: KA:Respond to Application Identifier The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. | 1 | Mand | | asAgent : Agent3 | 0-1 | Opt | | asLocatedEntity : LocatedEntity3 | 0-1 | Opt |
| |
| |
MCCI_MT002100CA.Message  Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II.TOKEN  Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME  Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText :  Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | responseModeCode : (ResponseMode)  Business name: Response Type Identifies whether the response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling. Essential to determining receiver behavior and therefore mandatory. | 1 | Mand | versionCode : (HL7StandardVersionCode)  Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II.PUBLIC  Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : LIST<II.OID>  Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID)  Business name: D:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition)  Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | respondTo : RespondTo | 0-1 | Opt | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt | controlActEvent :  | 0-1 | Req |
| |
| |
| |
| | MCCI_MT002100CA.Receiver |
|---|
typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device2 | 1 | Mand |
|
MCCI_MT002100CA.RespondTo  Business name: to be responded to by Indicates the interaction that should receive the response to this interaction. Used when different from the sender of the original interaction. In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
|---|
typeCode : "RSP" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: KB:Respond to Network Address Indicates the address to send acknowledgments of this message to. Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device3 | 1 | Mand |
| | MCCI_MT002100CA.Sender |
|---|
typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device1 | 1 | Mand |
|
|
|
|
|---|
| MCCI_MT002200CA.Acknowledgement |
|---|
typeCode : (AcknowledgementType)  Business name: GA:Acknowledgement Code Indicates whether the previous interaction was successfully processed. Key to understanding whether the interaction has been successful and is therefore mandatory. | 1 | Mand | messageWaitingNumber : INT.NONNEG  Business name: GC:Number of Waiting Messages For applications which support polling, indicates the total number of messages waiting to be retrieved. Indicates to a system how many polled messages are available without the need so send a separate query. The element is optional because not all systems will support polling. | 0-1 | Opt | messageWaitingPriorityCode : (MessageWaitingPriority)  Business name: GD:Message Waiting Priority Indicates the priority of the highest-priority message that is waiting on the poll queue for the system being responded to. The priority of the waiting message may influence how quickly the polling system may choose to download queued messages. The element is optional because not all systems will support polling. | 0-1 | Opt | | targetMessage : TargetMessage | 1 | Mand | | acknowledgementDetail : AcknowledgementDetail | 0-50 | Req |
| MCCI_MT002200CA.AcknowledgementDetail  Business name: Errors or Warnings An error, warning or information message associated with the message being acknowledged. Allows identification issues related to the parsing and low-level processing of the message. |
|---|
typeCode : (AcknowledgementDetailType)  Business name: Message type Distinguishes between errors, warnings and information messages. Different types of messages have substantially different ramifications. As a result, the element is mandatory. | 1 | Mand | code : (AcknowledgementDetailCode)  Business name: A:Response Code Indicates the specific issue represented by this message. By providing coded identification of issues and errors, allows applications to have logic that manages particular errors and warnings automatically. However in some circumstances, a code may not be available. Therefore the attribute is marked as 'populated'. | 1 | Pop | text :  Business name: C:Message Description The human-readable description of the error, warning or information message. May convey additional details not present in the 'code', but is not intended to be human-processable. Allows supplementing the 'computer' information for human-readability. | 0-1 | Req | location : SET<ST>  Business name: B:Referenced Message Locations Indicates the location of the elements within the message instance that triggered this error, warning or information message. I.e. only the default 'child' axis is permitted, occurrence numbers are always specified, and no other predicates are permitted. Allows syntax and other messages to be linked to particular fields within the message. | 0-5 | Req |
|
| |
MCCI_MT002200CA.AttentionLine  Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText :  Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value :  Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
| | MCCI_MT002200CA.Device1 |
|---|
classCode : "DEV" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: IA:Sending Application Identifier The unique identifier of the application or system to whom the message is being routed. Because this is the key identifier of where the message is intended to go, this attribute is mandatory. | 1 | Mand | name :  Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc :  Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE>  Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName :  Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName :  Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
|
| |
| MCCI_MT002200CA.Message  Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II.TOKEN  Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME  Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText :  Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | versionCode : (HL7StandardVersionCode)  Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II.PUBLIC  Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : LIST<II.OID>  Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID)  Business name: D:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition)  Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt | | acknowledgement : Acknowledgement | 1 | Mand |
|
| |
| |
| MCCI_MT002200CA.Receiver |
|---|
typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device2 | 1 | Mand |
| | MCCI_MT002200CA.Sender |
|---|
typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device1 | 1 | Mand |
|
| MCCI_MT002200CA.TargetMessage |
|---|
id : II.TOKEN  Business name: BA:Acknowledged Message Id References the identifier of the message this current message is acknowledging. Provides the necessary link to complete a conversation for systems using communication technologies which are not conversational. This attribute is therefore mandatory. | 1 | Mand |
|
|
|
|
|---|
| MCCI_MT002300CA.Acknowledgement |
|---|
typeCode : (AcknowledgementType)  Business name: GA:Acknowledgement Code Indicates whether the previous interaction was successfully processed. Key to understanding whether the interaction has been successful and is therefore mandatory. | 1 | Mand | messageWaitingNumber : INT.NONNEG  Business name: GC:Number of Waiting Messages For applications which support polling, indicates the total number of messages waiting to be retrieved. Indicates to a system how many polled messages are available without the need so send a separate query. The element is optional because not all systems will support polling. | 0-1 | Opt | messageWaitingPriorityCode : (MessageWaitingPriority)  Business name: GD:Message Waiting Priority Indicates the priority of the highest-priority message that is waiting on the poll queue for the system being responded to. The priority of the waiting message may influence how quickly the polling system may choose to download queued messages. The element is optional because not all systems will support polling. | 0-1 | Opt | | targetMessage : TargetMessage | 1 | Mand | | acknowledgementDetail : AcknowledgementDetail | 0-50 | Req |
| MCCI_MT002300CA.AcknowledgementDetail  Business name: Errors or Warnings An error, warning or information message associated with the message being acknowledged. Allows identification issues related to the parsing and low-level processing of the message. |
|---|
typeCode : (AcknowledgementDetailType)  Business name: Message type Distinguishes between errors, warnings and information messages. Different types of messages have substantially different ramifications. | 1 | Mand | code : (AcknowledgementDetailCode)  Business name: A:Response Code Indicates the specific issue represented by this message. By providing coded identification of issues and errors, allows applications to have logic that manages particular errors and warnings automatically. However in some circumstances, a code may not be available. Therefore the attribute is marked as 'populated'. | 1 | Pop | text :  Business name: C:Message Description The human-readable description of the error, warning or information message. May convey additional details not present in the 'code', but is not intended to be human-processable. Allows supplementing the 'computer' information for human-readability. | 0-1 | Req | location : SET<ST>  Business name: B:Referenced Message Locations Indicates the location of the elements within the message instance that triggered this error, warning or information message. I.e. only the default 'child' axis is permitted, occurrence numbers are always specified, and no other predicates are permitted. Allows syntax and other messages to be linked to particular fields within the message. | 0-5 | Req |
|
| |
| MCCI_MT002300CA.AttentionLine  Business name: Routing Instruction Lines Provides information on how the message should be routed within the receiving application. Allows direction of messages within complex applications. This association is optional because not all applications will require this level of routing. |
|---|
keyWordText :  Business name: A:Routing Type A particular type of guidance for routing the message. Allows categorization of routing types or support for multiple route pieces. Mandatory to understand the routing information. | 1 | Mand | value :  Business name: B:Routing Name Indicates the specific value used to route the item. Allows internal routing within an application. | 0-1 | Req |
|
| MCCI_MT002300CA.Device1 |
|---|
classCode : "DEV" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: IA:Sending Application Identifier The unique identifier of the application or system to whom the message is being routed. Because this is the key identifier of where the message is intended to go, this attribute is mandatory. | 1 | Mand | name :  Business name: IE:Sending Application Name This is the name associated with the system or application sending the message. Provides useful information when debugging. | 0-1 | Req | desc :  Business name: II:Sending Application Configuration Information Provides additional information about the configuration of the sending application. Useful when debugging. Provides additional information that may assist in debugging interactions. | 0-1 | Req | existenceTime : IVL.LOW<TS.FULLDATE>  Business name: IH:Sending Application Version Date Indicates the last time the sending application was modified or reconfigured. Can help to isolate the source of a problem when debugging. | 0-1 | Req | manufacturerModelName :  Business name: IG:Sending Software Version Number Indicates the version number of the piece of software used to construct the message. May be used to filter messages based on the compliance testing of the sending software. | 0-1 | Req | softwareName :  Business name: IF:Sending Application Software Name Indicates the name of the software used to construct the message. May be used to filter messages based on sending application compliance testing. | 0-1 | Req | | asAgent : Agent1 | 0-1 | Opt | | asLocatedEntity : LocatedEntity1 | 0-1 | Opt |
| |
MCCI_MT002300CA.Device3  Business name: Respond To System The system to which responses are to be directed. Provides support for directing responses to applications other than the original sender. |
|---|
classCode : "DEV" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: KA:Respond to Application Identifier The unique identifier of the applications to which responses should be sent. Only populated when different from the sending application id. Allows unique identification and routing to the application to be responded to. This attribute is mandatory be cause it is the principal identifier of the application to respond to. | 1 | Mand | | asAgent : Agent3 | 0-1 | Opt | | asLocatedEntity : LocatedEntity3 | 0-1 | Opt |
| |
| |
MCCI_MT002300CA.Message  Business name: HL7 Message The root class of all messages. Conveys information about the interaction and how it is to be processed |
|---|
id : II.TOKEN  Business name: A:Message Identifier A unique identifier for the message. Allows detection of duplicate messages, and allows tying acknowledgments to the message they are acknowledging. The attribute is therefore mandatory. | 1 | Mand | creationTime : TS.FULLDATETIME  Business name: G:Message Timestamp Indicates the time this particular message instance was constructed. Allows identification of how current the information in a message is. Also provides a baseline for identifying the time-zone of other times within the message. As a result, the attribute is mandatory. | 1 | Mand | securityText :  Business name: H:Security Token A locally-defined field used to maintain a session, identify a user, and/or perform some other function related to authenticating the message source. Allows jurisdictions and applications to communicate authentication and session information. The attribute is optional because not all jurisdictions will require this capability. | 0-1 | Opt | responseModeCode : (ResponseMode)  Business name: DA: Response Type Identifies whether the response is desired immediately (as a direct acknowledgement), on a deferred basis (as a subsequent independent interaction) or via queue using polling. Essential to determining receiver behavior and therefore mandatory. | 1 | Mand | versionCode : (HL7StandardVersionCode)  Business name: C: HL7 Standard Version Indicates the version of the messaging standard being referenced. Needed to know how to validate message definition, CMET definition, vocabulary and other information and is therefore mandatory. | 1 | Mand | interactionId : II.PUBLIC  Business name: B:Interaction Type Indicates the interaction conveyed by this message. Identifies what the receiving application should do, and how the message should be validated. The attribute is therefore mandatory. | 1 | Mand | profileId : LIST<II.OID>  Business name: F:Conformance Profile Identifiers Identifies the conformance profile(s) this message complies with. Indicates any additional validation that may be appropriate. Also influences what extensions can be processed. | 0-10 | Req | processingCode : (ProcessingID)  Business name: DB:Processing Code Indicates whether this message is intended to be processed as production, test or debug message. Indicates how the message should be handled and is therefore mandatory. | 1 | Mand | processingModeCode : "T" (ProcessingMode) | 1 | Mand | acceptAckCode : (AcknowledgementCondition)  Business name: E:Desired Acknowledgment Type Indicates how the message is expected to be acknowledged. Provides support for immediate, deferred and polling mode and distinguishes which mode is desired. The attribute is therefore mandatory. | 1 | Mand | | receiver : Receiver | 1 | Mand | | respondTo : RespondTo | 0-1 | Opt | | sender : Sender | 1 | Mand | | attentionLine : AttentionLine | 0-5 | Opt | | acknowledgement : Acknowledgement | 1 | Mand | controlActEvent :  | 0-1 | Req |
| |
| |
| |
| | MCCI_MT002300CA.Receiver |
|---|
typeCode : "RCV" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: JB:Receiver Network Address The address to which this message is being sent. Indicates where the message should be sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device2 | 1 | Mand |
|
MCCI_MT002300CA.RespondTo  Business name: to be responded to by Indicates the interaction that should receive the response to this interaction. Used when different from the sender of the original interaction. In complex routing environments, the acknowledgements may need to be sent to a system other than the one which constructed the original message. This association is optional because not all environments will support responses to systems other than the original sender. |
|---|
typeCode : "RSP" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: KB:Respond to Network Address Indicates the address to send acknowledgments of this message to. Needed when the address to respond to is different than that of the sender. This is optional because not all environments require network addresses. | 0-1 | Opt | | device : Device3 | 1 | Mand |
| | MCCI_MT002300CA.Sender |
|---|
typeCode : "SND" (CommunicationFunctionType) | 1 | Mand | telecom : TEL.URI  Business name: IB:Sending Network Address The network address of the application which sent the message. May be important for sender validation. Usually also the address to which responses are sent. This is optional because not all environments require network addresses. | 1 | Pop | | device : Device1 | 1 | Mand |
|
| MCCI_MT002300CA.TargetMessage |
|---|
id : II.TOKEN  Business name: BA:Acknowledged Message Id References the identifier of the message this current message is acknowledging. Provides the necessary link to complete a conversation for systems using communication technologies which are not conversational. This attribute is therefore mandatory. | 1 | Mand |
|
|
|
|
|---|
MFMI_MT700711CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: Critical for auditing and for validating permissions and therefore mandatory. |
|---|
typeCode : "AUT" (ParticipationType)  Value should always be AUT | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: D:Time of Creation The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.) This date can be back-dated. The time a change is made is a critical piece of audit information and is therefore mandatory. | 1 | Mand | modeCode : (ParticipationMode)  Business name: F:Information Received Method Indicates how the person who recorded the event became aware of it.. E.g. Verbal, written, fax, etc. May have ramifications for the audit trail and reliability of the information. | 0-1 | Req | signatureText : ED.SIGNATURE  Business name: G:Digital Signature Indicates the formal digital signature of the message content. Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. | 0-1 | Opt | | Choice: authorPerson : AuthorPerson | 1 | Pop | | »» 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 |
| |
MFMI_MT700711CA.AuthorRole  Business name: Null Author Role This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token. |
|---|
classCode : (RoleClass) | 1 | Mand |
| MFMI_MT700711CA.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. |
|---|
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 |
|
MFMI_MT700711CA.Component  Business name: Care Compositions A care composition is a record, which summarizes the events that happened during care including who is responsible for the care provided. Examples include encounters, health condition (episode)-based collections and general care-based collections such as "gynecological care". Allows linking records to encounters, condition and care-based compositions. Useful for searching and navigation of the patient's record. |
|---|
typeCode : (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd :  | 1 | Mand | | patientCareProvisionEvent : PatientCareProvisionEvent | 1 | Pop |
| MFMI_MT700711CA.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.FULLDATE>  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 | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 0-1 | Opt | | 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 : Subject | 0-50 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | componentOf : Component | 0-100 | Req |
|
| MFMI_MT700711CA.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. |
|---|
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 |
|
MFMI_MT700711CA.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. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| MFMI_MT700711CA.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. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| MFMI_MT700711CA.PriorRegisteredRole  Business name: Prior Registration Role Ids Identifies "duplicate" records of the registered item that have been superseded by this record. Provides support for merges. |
|---|
classCode : (RoleClass) | 1 | Mand | id : II.BUS  Business name: Prior Registered Role Ids Identifies "duplicate" records of the registered item that have been superseded by this record. Provides support for merges. | 1 | Mand |
|
| |
| |
| MFMI_MT700711CA.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 : "ON" (ContextControl) | 1 | Mand | contextConductionInd :  Business name: Cascade Responsibility Indicator Indicates whether or not objects of the trigger event are to be cascaded to the payload. Cascading of trigger event objects allows different messages to employ consistent and common objects. Attribute is mandatory to ensure that cascading will be specified one way or another. On creation interactions (where the state transition is null->active), this must be true otherwise it must be false. | 1 | Mand | | registrationRequest : RegistrationRequest | 1 | Mand |
|
MFMI_MT700711CA.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 |
| |
|
|
|
|
|---|
MFMI_MT700726CA.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.FULLDATE>  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 | | subject : Subject2 | 1 | Mand | | subjectOf : Subject | 0-50 | Req |
| |
MFMI_MT700726CA.PriorRegisteredRole  Business name: Prior Registration Role Ids Identifies "duplicate" records of the registered item that have been superseded by this record. Provides support for merges. |
|---|
classCode : (RoleClass) | 1 | Mand | id : II.BUS  Business name: Prior Registered Role Ids Identifies "duplicate" records of the registered item that have been superseded by this record. Provides support for merges. | 1 | Mand |
| |
| |
| MFMI_MT700726CA.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 : "ON" (ContextControl) | 1 | Mand | contextConductionInd :  Business name: Cascade Responsibility Indicator Indicates whether or not objects of the trigger event are to be cascaded to the payload. Cascading of trigger event objects allows different messages to employ consistent and common objects. Attribute is mandatory to ensure that cascading will be specified one way or another. On creation interactions (where the state transition is null->active), this must be true otherwise it must be false. | 1 | Mand | | registrationRequest : RegistrationRequest | 1 | Mand |
|
| |
|
|
|
|---|
MFMI_MT700746CA.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.FULLDATE>  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 | | subject : Subject2 | 0-1000 | Req | | subjectOf : Subject | 0-50 | Req |
| |
MFMI_MT700746CA.PriorRegisteredRole  Business name: Prior Registration Role Ids Identifies "duplicate" records of the registered item that have been superseded by this record. Provides support for merges. |
|---|
classCode : (RoleClass) | 1 | Mand | id : II.BUS  Business name: Prior Registered Role Ids Identifies "duplicate" records of the registered item that have been superseded by this record. Provides support for merges. | 1 | Mand |
| |
| |
| MFMI_MT700746CA.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 : "ON" (ContextControl) | 1 | Mand | contextConductionInd :  Business name: Cascade Responsibility Indicator Indicates whether or not objects of the trigger event are to be cascaded to the payload. Cascading of trigger event objects allows different messages to employ consistent and common objects. Attribute is mandatory to ensure that cascading will be specified one way or another. On creation interactions (where the state transition is null->active), this must be true otherwise it must be false. | 1 | Mand | | registrationRequest : RegistrationRequest | 1 | Pop |
|
| |
|
|
|
|---|
| |
| |
POIZ_MT061150CA.Immunization  Business name: Immunizations A record of a products administered to a patient specific to immunization. Necessary component of a person's overall vaccine profile. Helps deal with outbreaks and also vaccine contraindication checking. |
|---|
classCode : "SBADM" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.PUBLIC  Business name: A:Immunization Record Id This is an identifier assigned to a unique instance of an immunization record. Allows for the unique referencing of a specific immunization record. This should be known for query responses and is, therefore, mandatory. | 1 | Mand | code : CD (ActCode)  Business name: Immunization Type Indicates what type of substance admininstration is being performed, and in this instance is specialized to identify it as an immunization. Indicates that an immunization is being performed and for SNOMED, also indicates the specific type of administration. Therefore, the attribute is mandatory. The attribute is CD to allow for SNOMED post-coordination. | 1 | Mand | negationInd :  Business name: Not Immunized? An explicit indication that a person has not been immunized with the specified vaccine at the time indicated. Tracking failures to be immunized is also important in immunization reporting. Marked as mandatory because it is not meaningful for this flag to be 'unknown'. | 1 | Mand | statusCode : (ActStatus)  Business name: Immunization Event Status Status of the immunization event Nullified=Retracted Needed to differentiate between valid and invalid immunization events (e.g. immunization event has been retracted or nullified) and is therefore mandatory. | 1 | Mand | effectiveTime : TS.DATE  Business name: Immunization Date The date the vaccine was administered to the patient. Important information for establishing the validity of the immunization records, and therefore mandatory. Also used in the scheduling of subsequent immunizations. | 1 | Mand | uncertaintyCode : (ActUncertainty)  Business name: Uncertainty Code An indication of uncertainty regarding an immunization event Only populated when it is needed to communicate a degree of uncertainty - e.g. historical data. Allows for users of information to determine the degree of uncertainty regarding the details of an immunization event and is therefore populated. | 1 | Pop | | subject : Subject10 | 1 | Mand | | consumable : Consumable | 1 | Mand | | subjectOf1 : Subject2 | 0-1 | Req | | subjectOf2 : Subject | 0-25 | Opt | | cause : CauseOf | 0-1 | Req |
| POIZ_MT061150CA.InvestigationEvent  Business name: Adverse Event Report Contains information about an adverse event report that is related to the immunization event. Provides a reference to a related adverse event report. |
|---|
classCode : "INVSTG" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.PUBLIC  Business name: Adverse Event Report ID Uniquely identifies the adverse event report. Needed to reference related adverse event report. As this is used for referencing a known report, this attribute is mandatory. | 1 | Mand | code : (IndividualCaseSafetyReportType)  Business name: Report Type Coded value used to identify the type of report. Allows greater specificity when describing the type of adverse event report. As a result, this attribute is mandatory. | 1 | Mand | statusCode : (ActStatus)  Business name: Report Status Code indicating the operative status of the business process, which in this case is an Adverse Event Report. Status examples: active, cancelled, held. Provides additional context to the receiver as to the state of the referenced report. As a result, this attribute is mandatory. | 1 | Mand |
|
| POIZ_MT061150CA.Subject10  Business name: *administered to Indicates the patient who was immunized. Essential for linking the immunization to the patient's record, and is therefore mandatory. |
|---|
typeCode : "SBJ" (ParticipationType)  RIM:A code specifying the meaning and purpose of every ActRelationship instance. Each of its values implies specific constraints to what kinds of Act objects can be related and in which way. | 1 | Mand | contextControlCode : "OP" (ContextControl)  A code that specifies how this ActRelationship contributes to the context of the current Act, and whether it may be propagated to descendent Acts whose association allows such propagation This attribute allows the clear specification of whether an association adds to the context associated with a particular item (e.g. adding an additional author) or whether it replaces (overrides) part of the context associated with a particular item (e.g. identifying a sole author, independent of the containing item). It also indicates whether the association applies to only this act (non-propagating), or whether it may apply to derived acts as well (propagating). As a result, this attribute is mandatory. | 1 | Mand | | patient : Patient | 1 | Mand |
|
|
|
|
|
|---|
PRLO_DM000000CA.ContactParty  |
|---|
classCode : "CON" (RoleClass) | 1 | Mand | code : (AdministrativeContactRoleType)  | 1 | Mand | addr : AD.BASIC  | 0-1 | Req | telecom : SET<TEL.PHONEMAIL>  | 0-3 | Req |
| PRLO_DM000000CA.DirectAuthorityOver  Business name: i:contactable through Identifies the various means by which the location may be contacted and the types of contacts that exist. Effectively acts as a mini-yellow pages or directory for the service delivery location. Locations will frequently need to be reached to ask questions, schedule appointments, etc. They may also need to direct patients to reach the location. This is handled as a separate component because many larger facilities have numerous functions. The contact information for emergency is not the same as the contact for admitting or the finance department. |
|---|
typeCode : "DIRAUTH" (RoleLinkType) | 1 | Mand | | contactParty : ContactParty | 1 | Pop |
|
PRLO_DM000000CA.IdentifiedLocation  Business name: *k:has Provides additional identifiers by which the location may be known. In a registry, it is often necessary to link a location record to other registries or to commonly used jurisdictional identifiers. |
|---|
classCode : "IDENT" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Identifier An identifier by which the location is known. Specifies the actual identifier that can be used for searching or linking. The attribute is mandatory because there is no point specifying an "Other Identifiers" class if you are not going to specify an identifier. | 1 | Mand | code : (LocationIdentifiedEntityRoleType)  Business name: B:Identifier Type Specifies the kind of identifier being communicated. For example, billing identifier, regional identifier, public health identifier, etc. Provides context around the appropriate use for the identifier and is therefore mandatory. | 1 | Mand | | assigningIdentifierOrganization : IdentifierOrganization | 1 | Mand |
| PRLO_DM000000CA.IdentifierOrganization  Business name: Other Identifiers Describes additional identifiers for this service delivery location by which it may be queried or reported on. Allows a source delivery location to be identified with more than one identifier for linking or historical purposes. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C: Identifying Organization This is the name of the organization which issued and/or uses the identifier for the location. Further qualifies how the identifier is intended to be used. For example distinguishing a health-region assigned identifier from a provincially-assigned identifier. Because it is important to understanding the identifier, the attribute is mandatory. | 1 | Mand |
|
| |
PRLO_DM000000CA.Organization  Business name: B:Responsible Organization The organization responsible for the operations of the service delivery location. To provide additional information regarding the management and administration of the service delivery location. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: A: Responsible Organization Identifier Unique identifier for the responsible organization. The expectation is that these identifiers can be retrieved from jurisdictional provider registries. Where organization identifiers are not maintained in the registry, they may be omitted or alternative identifier sources may be used (e.g. identifiers issued by health regions). Allows drilling down for additional information about the organization. May also be used as a query parameter. | 0-1 | Req | name :  Business name: B: Responsible Organization Name The label by which the responsible organization is known and communicated with e.g. Capital Health District. Provides a user-accessible label for the organization and is therefore mandatory. | 1 | Mand |
| PRLO_DM000000CA.Part  Business name: m:contains Identifies component service delivery locations within the parent location. E.g. Buildings within a campus, wards within a building, etc. Allows for drill-down as well as providing context about the capabilities of the parent service delivery locaiton. |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | subLocation : SubLocation | 1 | Pop |
|
PRLO_DM000000CA.Part2  Business name: l:part of Identifies a location of which this location is a part. Allows a query response to return multiple levels of information when describing a location. For example "Emergency Ward at Good Health Hospital". The recursion depth is restricted to 1 I.e. nesting only one level |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| | PRLO_DM000000CA.Place |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: E:Location Place Type Distinguishes different levels of location granularity. E.g. Campus, building, floor, ward, room, bed. Used for searching, as well as for understanding what is meant by a particular location and is therefore mandatory. | 1 | Mand | mobileInd :  Business name: F:Location Mobile Indicator An indication of whether a place has the capability to move from one location to another. Example: air and ground ambulances, mobile clinics. Allows flagging that the location does not have a fixed physical location. This element must always be known and is therefore mandatory. | 1 | Mand | | asIdentifiedLocation : IdentifiedLocation | 0-5 | Req |
|
PRLO_DM000000CA.ServiceDefinition  Business name: Available Services A list of available services provided by the service delivery location. Useful when searching for a location to provide a particular service. May be used to filter query responses. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | code : (ActServiceDeliveryLocationService)  Business name: A: Service Type Describes the kind of health-related service being offered. This is the attribute that defines what the service is and is therefore mandatory. | 1 | Mand | statusCode : (x_ActStatusActiveSuspended)  Business name: B: Service Availability Indicates the availability of the health-related service within the location (as known by the registry/repository). e.g. active (currently offered), suspended (may have been offered in the past and may again be offered in the future, but not available right now). Services may not be always available; it is important to know whether a service is currently available when making decisions about where to send a patient. Because not all jurisdictions will support capturing availability time, this element is being made optional. | 0-1 | Opt | activityTime : SET<PIVL<TS.FULLDATETIME>>  Business name: C: Service Availability Time Specifies the time that a specific service is generally available. E.g. 8am to 7pm, Monday through Friday. Allows for a greater level of detail on service availability, i.e. hours of operation of a specific service at this location. We'd like this to be String, but need a datatype change to make that possible. | 0-1 | Req |
| PRLO_DM000000CA.ServiceDeliveryLocation  Business name: Location Any location where health-related services may be provided. Note that a single physical place can play multiple service delivery location roles e.g. a Podiatry clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number. Provides location information which uniquely identifies where health services are provided. This includes details and other supporting information on locations e.g. name, address, organization and contact parties. Needed when looking up facilities to link to patient records. Also useful when trying to find facilities to meet particular patient needs, as well as looking up how to contact the location. At least one of address or coordinate must be specified unless the place is mobile. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A: Location Identifier A globally unique identifier assigned by the EHR to the Location record. Allows for unique identification of the Location and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 0-2 | Opt | code : (ServiceDeliveryLocationRoleType)  Business name: B: Location Type Identifies the type of Location represented by this record. For example, a service delivery location may be either an incidental service delivery location (a place at which health-related services may be provided without prior designation or authorization such as a church or school) or a dedicated service delivery location (a place that is intended to house the provision of health-related services such as a clinic or hospital). Dedicated service delivery locations can be further characterized as either clinical or non-clinical. Location Type is used for searching and for organizing Location records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | name : SET<TN>  Business name: D:Location Names A textual name for the place where the service is provided e.g. Ottawa General Hospital. Provides a human-readable label for the location. The location name is not intended to be parsed or analyzed by when processing the record. (E.g. To determine if a location is a hospital, look at the location type, don't check the name for the word "hospital".) Multiple repetitions are allowed to capture historical names | 0-5 | Req | addr : AD.BASIC  Business name: G:Location Address Identifies the physical address for this service delivery location, I.e. What is the geographic location of the building. For mobile service delivery location, this can either be set to the address of the "home" site for the mobile unit or can be set to a null flavor of N/A. Allows location to be visited. May also be used for geographic profiling (e.g. a dispatcher may be looking for the closest hospital or ambulance that can help a patient in need of emergency care). Because a physical address may not exist for mobile locations, and may not be expressible for non-dedicated locations such as water resevoirs, this element is only 'populated'. When no address exists, the null flavor should be set to NA. Restricted to physical address only | 1 | Pop | statusCode : (ServiceDeliveryRoleStatus)  Business name: C: Location Status This identifies the current state of the Location record. Allowed status values are 'active' (the location is actively used to deliver healthcare-related services), 'suspended' (the location has temporarily ceased delivering healthcare-related services) and 'terminated' (the location has permanently ceased delivering healthcare-related services and may no longer physically exist.) Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Location record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | | location : Place | 1 | Mand | | serviceProviderOrganization : Organization | 0-1 | Req | | subjectOf : Subject | 0-5 | Opt | | locationOf : Location | 0-100 | Req | | directAuthorityOver : DirectAuthorityOver | 0-100 | Req | | part : Part | 0-100 | Req | | sourceOf : SourceOf | 1 | Mand | | indirectAuthority : IndirectAuthorithyOver | 1 | Pop | | partOf : Part2 | 0-1 | Req |
|
PRLO_DM000000CA.SourceOf  Business name: *a:stored in This indicates the EHR repository the Location record is stored in. Different EHRs may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
|---|
typeCode : "CUST" (RoleLinkType) | 1 | Mand | | assignedDevice : AssignedDevice | 1 | Mand |
| PRLO_DM000000CA.SubLocation  Business name: Sub-Locations Identifies service delivery locations contained within the described "parent" service delivery location. Allows a more thorough understanding of the capabilities of the service delivery location, as well as drill-down to component parts. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Sub-Location Identifier Unique identifier for the contained service delivery location Allows subsequent queries to drill down to detail information about this specific sub location and is therefore mandatory. | 1 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Sub-Location Type Describes the 'type' of component service delivery location. For example, a hospital might contain a laboratory or a community clinic. Provides context about what the capabilities of the component service delivery location are. Allows for unique identification of a sub-location and is therefore mandatory. | 1 | Mand | name : TN  Business name: Location Name A descriptive name for the sub-location. Provides a human-readable label for the location and is therefore mandatory. In general, names of sub-locations will be unique within their containing location. | 1 | Mand | | location : SubPlace | 1 | Mand |
|
| PRLO_DM000000CA.SubPlace |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: D: Sub-Location Place Type Identifies the physical type of the component location. For example, a campus may contain a building, a building may contain a ward, etc. Provides context about the type of sub-location. Used for searching, as well as for understanding what is meant by a particular sub-location and is therefore mandatory. | 1 | Mand |
| |
| PRLO_DM000000CA.TerritorialAuthority |
|---|
classCode : "TERR" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: H: Location Region Id Identifies the health region associated with the service delivery location (if any). In Canada, many service delivery locations are organized into regions for administrative, coordination and/or funding reasons. Regions may influence where a patient may go for services. They may also be used for searching. Because not all service delivery locations are associated with a region, this element is only 'populated' to allow null flavors such as 'NA'. | 1 | Pop |
|
|
|
|
|---|
| | PRLO_MT000001CA.Place |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: E:Location Place Type Distinguishes different levels of location granularity. E.g. Campus, building, floor, ward, room, bed. Used for searching, as well as for understanding what is meant by a particular location and is therefore mandatory. | 1 | Mand | mobileInd :  Business name: F:Location Mobile Indicator An indication of whether a place has the capability to move from one location to another. Example: air and ground ambulances, mobile clinics. Allows flagging that the location does not have a fixed physical location. This element must always be known and is therefore mandatory. | 1 | Mand |
|
PRLO_MT000001CA.ServiceDeliveryLocation  Business name: Location Any location where health-related services may be provided. Note that a single physical place can play multiple service delivery location roles e.g. a Podiatry clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number. Provides location information which uniquely identifies where health services are provided. This includes details and other supporting information on locations e.g. name, address, organization and contact parties. Needed when looking up facilities to link to patient records. Also useful when trying to find facilities to meet particular patient needs, as well as looking up how to contact the location. At least one of address or coordinate must be specified unless the place is mobile. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II.BUS  Business name: A: Location Identifier A globally unique identifier assigned by the EHR to the Location record. Allows for unique identification of the Location and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 1 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Location Type Identifies the type of Location represented by this record. For example, a service delivery location may be either an incidental service delivery location (a place at which health-related services may be provided without prior designation or authorization such as a church or school) or a dedicated service delivery location (a place that is intended to house the provision of health-related services such as a clinic or hospital). Dedicated service delivery locations can be further characterized as either clinical or non-clinical. Location Type is used for searching and for organizing Location records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | name : SET<TN>  Business name: D:Location Names A textual name for the place where the service is provided e.g. Ottawa General Hospital. Provides a human-readable label for the location. The location name is not intended to be parsed or analyzed by when processing the record. (E.g. To determine if a location is a hospital, look at the location type, don't check the name for the word "hospital".) Multiple repetitions are allowed to capture historical names | 0-5 | Req | addr : AD.BASIC  Business name: G:Location Address Identifies the physical address for this service delivery location, I.e. What is the geographic location of the building. For mobile service delivery location, this can either be set to the address of the "home" site for the mobile unit or can be set to a null flavor of N/A. Allows location to be visited. May also be used for geographic profiling (e.g. a dispatcher may be looking for the closest hospital or ambulance that can help a patient in need of emergency care). Because a physical address may not exist for mobile locations, and may not be expressible for non-dedicated locations such as water resevoirs, this element is only 'populated'. When no address exists, the null flavor should be set to NA. Restricted to physical address only | 1 | Pop | statusCode : (ServiceDeliveryRoleStatus)  Business name: C: Location Status This identifies the current state of the Location record. Allowed status values are 'active' (the location is actively used to deliver healthcare-related services), 'suspended' (the location has temporarily ceased delivering healthcare-related services) and 'terminated' (the location has permanently ceased delivering healthcare-related services and may no longer physically exist.) Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Location record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | | location : Place | 1 | Mand | | subjectOf : Subject | 0-5 | Opt | | sourceOf : SourceOf | 1 | Mand | | indirectAuthority : IndirectAuthorithyOver | 1 | Pop |
| PRLO_MT000001CA.SourceOf  Business name: *a:stored in This indicates the EHR repository the Location record is stored in. Different EHRs may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
|---|
typeCode : "CUST" (RoleLinkType) | 1 | Mand | | assignedDevice : AssignedDevice | 1 | Mand |
|
| | PRLO_MT000001CA.TerritorialAuthority |
|---|
classCode : "TERR" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: H: Location Region Id Identifies the health region associated with the service delivery location (if any). In Canada, many service delivery locations are organized into regions for administrative, coordination and/or funding reasons. Regions may influence where a patient may go for services. They may also be used for searching. Because not all service delivery locations are associated with a region, this element is only 'populated' to allow null flavors such as 'NA'. | 1 | Pop |
|
|
|
|
|---|
PRLO_MT000002CA.ContactParty  |
|---|
classCode : "CON" (RoleClass) | 1 | Mand | code : (AdministrativeContactRoleType)  | 1 | Mand | addr : AD.BASIC  | 0-1 | Req | telecom : SET<TEL.PHONEMAIL>  | 0-3 | Req |
| PRLO_MT000002CA.DirectAuthorityOver  Business name: i:contactable through Identifies the various means by which the location may be contacted and the types of contacts that exist. Effectively acts as a mini-yellow pages or directory for the service delivery location. Locations will frequently need to be reached to ask questions, schedule appointments, etc. They may also need to direct patients to reach the location. This is handled as a separate component because many larger facilities have numerous functions. The contact information for emergency is not the same as the contact for admitting or the finance department. |
|---|
typeCode : "DIRAUTH" (RoleLinkType) | 1 | Mand | | contactParty : ContactParty | 1 | Pop |
|
PRLO_MT000002CA.IdentifiedLocation  Business name: *k:has Provides additional identifiers by which the location may be known. In a registry, it is often necessary to link a location record to other registries or to commonly used jurisdictional identifiers. |
|---|
classCode : "IDENT" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Identifier An identifier by which the location is known. Specifies the actual identifier that can be used for searching or linking. The attribute is mandatory because there is no point specifying an "Other Identifiers" class if you are not going to specify an identifier. | 1 | Mand | code : (LocationIdentifiedEntityRoleType)  Business name: B:Identifier Type Specifies the kind of identifier being communicated. For example, billing identifier, regional identifier, public health identifier, etc. Provides context around the appropriate use for the identifier and is therefore mandatory. | 1 | Mand | | assigningIdentifierOrganization : IdentifierOrganization | 1 | Mand |
| PRLO_MT000002CA.IdentifierOrganization  Business name: Other Identifiers Describes additional identifiers for this service delivery location by which it may be queried or reported on. Allows a source delivery location to be identified with more than one identifier for linking or historical purposes. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C: Identifying Organization This is the name of the organization which issued and/or uses the identifier for the location. Further qualifies how the identifier is intended to be used. For example distinguishing a health-region assigned identifier from a provincially-assigned identifier. Because it is important to understanding the identifier, the attribute is mandatory. | 1 | Mand |
|
| |
PRLO_MT000002CA.Organization  Business name: B:Responsible Organization The organization responsible for the operations of the service delivery location. To provide additional information regarding the management and administration of the service delivery location. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: A: Responsible Organization Identifier Unique identifier for the responsible organization. The expectation is that these identifiers can be retrieved from jurisdictional provider registries. Where organization identifiers are not maintained in the registry, they may be omitted or alternative identifier sources may be used (e.g. identifiers issued by health regions). Allows drilling down for additional information about the organization. May also be used as a query parameter. | 0-1 | Req | name :  Business name: B: Responsible Organization Name The label by which the responsible organization is known and communicated with e.g. Capital Health District. Provides a user-accessible label for the organization and is therefore mandatory. | 1 | Mand |
| PRLO_MT000002CA.Part  Business name: m:contains Identifies component service delivery locations within the parent location. E.g. Buildings within a campus, wards within a building, etc. Allows for drill-down as well as providing context about the capabilities of the parent service delivery locaiton. |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | subLocation : SubLocation | 1 | Pop |
|
PRLO_MT000002CA.Part2  Business name: l:part of Identifies a location of which this location is a part. Allows a query response to return multiple levels of information when describing a location. For example "Emergency Ward at Good Health Hospital". The recursion depth is restricted to 1 I.e. nesting only one level |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| | PRLO_MT000002CA.Place |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: E:Location Place Type Distinguishes different levels of location granularity. E.g. Campus, building, floor, ward, room, bed. Used for searching, as well as for understanding what is meant by a particular location and is therefore mandatory. | 1 | Mand | mobileInd :  Business name: F:Location Mobile Indicator An indication of whether a place has the capability to move from one location to another. Example: air and ground ambulances, mobile clinics. Allows flagging that the location does not have a fixed physical location. This element must always be known and is therefore mandatory. | 1 | Mand | | asIdentifiedLocation : IdentifiedLocation | 0-5 | Req |
|
PRLO_MT000002CA.ServiceDefinition  Business name: Available Services A list of available services provided by the service delivery location. Useful when searching for a location to provide a particular service. May be used to filter query responses. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | code : (ActServiceDeliveryLocationService)  Business name: A: Service Type Describes the kind of health-related service being offered. This is the attribute that defines what the service is and is therefore mandatory. | 1 | Mand | statusCode : (x_ActStatusActiveSuspended)  Business name: B: Service Availability Indicates the availability of the health-related service within the location (as known by the registry/repository). e.g. active (currently offered), suspended (may have been offered in the past and may again be offered in the future, but not available right now). Services may not be always available; it is important to know whether a service is currently available when making decisions about where to send a patient. Because not all jurisdictions will support capturing availability time, this element is being made optional. | 0-1 | Opt | activityTime : SET<PIVL<TS.FULLDATETIME>>  Business name: C: Service Availability Time Specifies the time that a specific service is generally available. E.g. 8am to 7pm, Monday through Friday. Allows for a greater level of detail on service availability, i.e. hours of operation of a specific service at this location. We'd like this to be String, but need a datatype change to make that possible. | 0-1 | Req |
| PRLO_MT000002CA.ServiceDeliveryLocation  Business name: Location Any location where health-related services may be provided. Note that a single physical place can play multiple service delivery location roles e.g. a Podiatry clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number. Provides location information which uniquely identifies where health services are provided. This includes details and other supporting information on locations e.g. name, address, organization and contact parties. Needed when looking up facilities to link to patient records. Also useful when trying to find facilities to meet particular patient needs, as well as looking up how to contact the location. At least one of address or coordinate must be specified unless the place is mobile. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A:Location Identifiers A globally unique identifier assigned by the EHR to the Location record. Allows for unique identification of the Location and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 2 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Location Type Identifies the type of Location represented by this record. For example, a service delivery location may be either an incidental service delivery location (a place at which health-related services may be provided without prior designation or authorization such as a church or school) or a dedicated service delivery location (a place that is intended to house the provision of health-related services such as a clinic or hospital). Dedicated service delivery locations can be further characterized as either clinical or non-clinical. Location Type is used for searching and for organizing Location records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | name : SET<TN>  Business name: D:Location Names A textual name for the place where the service is provided e.g. Ottawa General Hospital. Provides a human-readable label for the location. The location name is not intended to be parsed or analyzed by when processing the record. (E.g. To determine if a location is a hospital, look at the location type, don't check the name for the word "hospital".) Multiple repetitions are allowed to capture historical names | 0-5 | Req | addr : AD.BASIC  Business name: G:Location Address Identifies the physical address for this service delivery location, I.e. What is the geographic location of the building. For mobile service delivery location, this can either be set to the address of the "home" site for the mobile unit or can be set to a null flavor of N/A. Allows location to be visited. May also be used for geographic profiling (e.g. a dispatcher may be looking for the closest hospital or ambulance that can help a patient in need of emergency care). Because a physical address may not exist for mobile locations, and may not be expressible for non-dedicated locations such as water resevoirs, this element is only 'populated'. When no address exists, the null flavor should be set to NA. Restricted to physical address only | 1 | Pop | statusCode : (ServiceDeliveryRoleStatus)  Business name: C: Location Status This identifies the current state of the Location record. Allowed status values are 'active' (the location is actively used to deliver healthcare-related services), 'suspended' (the location has temporarily ceased delivering healthcare-related services) and 'terminated' (the location has permanently ceased delivering healthcare-related services and may no longer physically exist.) Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Location record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | | location : Place | 1 | Mand | | serviceProviderOrganization : Organization | 0-1 | Req | | subjectOf : Subject | 0-5 | Opt | | locationOf : Location | 0-100 | Req | | directAuthorityOver : DirectAuthorityOver | 0-100 | Req | | part : Part | 0-100 | Req | | sourceOf : SourceOf | 1 | Mand | | indirectAuthority : IndirectAuthorithyOver | 1 | Pop | | partOf : Part2 | 0-1 | Req |
|
PRLO_MT000002CA.SourceOf  Business name: *a:stored in This indicates the EHR repository the Location record is stored in. Different EHRs may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
|---|
typeCode : "CUST" (RoleLinkType) | 1 | Mand | | assignedDevice : AssignedDevice | 1 | Mand |
| PRLO_MT000002CA.SubLocation  Business name: Sub-Locations Identifies service delivery locations contained within the described "parent" service delivery location. Allows a more thorough understanding of the capabilities of the service delivery location, as well as drill-down to component parts. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Sub-Location Identifier Unique identifier for the contained service delivery location Allows subsequent queries to drill down to detail information about this specific sub location and is therefore mandatory. | 1 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Sub-Location Type Describes the 'type' of component service delivery location. For example, a hospital might contain a laboratory or a community clinic. Provides context about what the capabilities of the component service delivery location are. Allows for unique identification of a sub-location and is therefore mandatory. | 1 | Mand | name : TN  Business name: Location Name A descriptive name for the sub-location. Provides a human-readable label for the location and is therefore mandatory. In general, names of sub-locations will be unique within their containing location. | 1 | Mand | | location : SubPlace | 1 | Mand |
|
| PRLO_MT000002CA.SubPlace |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: D: Sub-Location Place Type Identifies the physical type of the component location. For example, a campus may contain a building, a building may contain a ward, etc. Provides context about the type of sub-location. Used for searching, as well as for understanding what is meant by a particular sub-location and is therefore mandatory. | 1 | Mand |
| |
| PRLO_MT000002CA.TerritorialAuthority |
|---|
classCode : "TERR" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: H: Location Region Id Identifies the health region associated with the service delivery location (if any). In Canada, many service delivery locations are organized into regions for administrative, coordination and/or funding reasons. Regions may influence where a patient may go for services. They may also be used for searching. Because not all service delivery locations are associated with a region, this element is only 'populated' to allow null flavors such as 'NA'. | 1 | Pop |
|
|
|
|
|---|
| PRLO_MT000003CA.Address |
|---|
value : AD.SEARCH  Business name: ZE: Address If specified, filters the returned location records to those in the specified province/territory or municipality. Allows filtering the physical location of the facility. | 1 | Mand |
| | PRLO_MT000003CA.AmendedSinceDateTime |
|---|
value : TS.FULLDATETIME  Business name: K: Updated Since DateTime Filters the records retrieved to only include those which have been created or revised since the specified date and time. If unspecified, no filter is applied. Useful to retrieve information "since you last checked". | 1 | Mand |
|
| PRLO_MT000003CA.EHRRepositoryId |
|---|
value : II.BUS  Business name: Q: EHR Repository Id Filters the records retrieved to only include those records from a specific EHR repository. If unspecified, all "connected" EHR repositories will be searched. Primarily intended to allow filtering an initial search to a local EHR repository for performance reasons. | 1 | Mand |
| | PRLO_MT000003CA.LocationMobileIndicator |
|---|
value :  Business name: ZC: Location Mobile Indicator If specified, filters the returned location records to either those which are mobile or non-mobile. If unspecified, no filter is applied. Allows restricting to either mobile or non-mobile locations. | 1 | Mand |
|
| PRLO_MT000003CA.LocationPlaceType |
|---|
value : (ServiceDeliveryLocationPlaceType)  Business name: ZA: Location Place Type Filters the returned location records to only include specific types of places such as facilities, departments, buildings, wards, etc. Allows constraining the types of records to retrieve. Multiple repetitions are provided to allow more than one type to be included. | 1 | Mand |
| | PRLO_MT000003CA.LocationServiceType |
|---|
value : (ActServiceDeliveryLocationService)  Business name: ZB: Location Service Types Filters the returned location records to only include locations that provide the specified type of service(s), etc. Multiple repetitions will be treated as "AND". I.e. Locations that provide A and B. If this criterion is used, it will only match on services that are marked as "available". Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows searching for facilities able to deliver certain services or groups of services. | 1 | Mand |
|
| PRLO_MT000003CA.NameContains |
|---|
value :  Business name: Z: Name Contains Filters the returned location records to only include those whose name includes the specified string. If unspecified, no filter is applied. Allows searching by name. Note: Searches should be case-insensitive and should ignore punctuation and spacing. Some implementations may perform "sounds-like" searches. | 1 | Mand |
| | PRLO_MT000003CA.NearAddress |
|---|
value : AD.BASIC  Business name: ZF: Near Address Identifies an address that returned locations should be near to. Results will be filtered to those appearing within the specified radius from the identified address. Allows retrieving facilities near to a particular location. | 1 | Mand |
|
| | PRLO_MT000003CA.ProtocolId |
|---|
value : II.BUS  Business name: ZI: Protocol Ids Filters the records retrieved to only include those associated with the specified protocols. If unspecified, no filter is applied. Allows retrieving records associated with a particular protocol. Useful in clinical studies and other research. The element is optional because support for protocols is not deemed a neccesity for many healthcare providers. | 1 | Mand |
|
| PRLO_MT000003CA.RecordStatus |
|---|
value : (ServiceDeliveryRoleStatus)  Business name: I: Record Statuses Filters the set of records to be retrieved to only include those with the identified status(s). If no values are specified, no filter will be applied. Allows constraining the status of records to be retrieved. Multiple repetitions are present to allow selection of multiple statuses with a single query. | 1 | Mand |
| | PRLO_MT000003CA.RecordType |
|---|
value : CD (ServiceDeliveryLocationRoleType)  Business name: H:Record Types Filters the type(s) or category(ies) of the records to be retrieved. The query will return both those records whose type exactly matches, as well as those whose types are subsets of the specified parameter. If no Types are specified, no restriction will be placed on the types to be returned. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows constraining the type of records to be retrieved. Multiple repetitions are present to allow selection of multiple types with a single query. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| PRLO_MT000003CA.RegionId |
|---|
value : II.PUBLIC  Business name: ZD: Region Ids If specified, filters the returned location records to those which are part of the specified 'region'. Allows restricting the retrieved locations to those associated with a particular health region. | 1 | Mand |
| | PRLO_MT000003CA.ResponsibleOrganizationId |
|---|
value : II.PUBLIC  Business name: ZH: Responsible Organization Id If specified, filters the returned location records to those which are under the responsibility of the specified organization. Allows returning all locations associated with a particular organization. | 1 | Mand |
|
| PRLO_MT000003CA.SearchRadius |
|---|
value : PQ.DISTANCE  Business name: ZG: Search Radius Identifies the distance from the "Near Address" within which locations should be retrieved. Allows retrieving facilities near to a particular location. | 1 | Mand |
|
|
|
|
|---|
PRLO_MT000004CA.ParameterList  Business name: Query Definition Identifies the various parameters that act as filters on the records to be retrieved. Allows the user and/or the point-of-service application to constrain what EHR information they wish to retrieve. Search Radius may only be specified if Near Address is specified |
|---|
| protocolId : ProtocolId | 0-5 | Opt | | recordId : RecordId | 1-5 | Mand |
| | PRLO_MT000004CA.ProtocolId |
|---|
value : II.BUS  Business name: ZI: Protocol Ids Filters the records retrieved to only include those associated with the specified protocols. If unspecified, no filter is applied. Allows retrieving records associated with a particular protocol. Useful in clinical studies and other research. The element is optional because support for protocols is not deemed a neccesity for many healthcare providers. | 1 | Mand |
|
| PRLO_MT000004CA.RecordId |
|---|
value : II.BUS  Business name: E: Record Ids A globally unique identifier assigned by the EHR to the record (or records) to be retrieved. Specifically identifies the record to be returned. Because the primary purpose of the query is to retrieve identified records, the element is mandatory. Multiple repetitions are allowed to support multiple detail records as part of one query for efficiency reasons. | 1 | Mand |
|
|
|
|
|---|
PRLO_MT202014CA.ContactParty  |
|---|
classCode : "CON" (RoleClass) | 1 | Mand | code : (AdministrativeContactRoleType)  | 1 | Mand | addr : AD.BASIC  | 0-1 | Req | telecom : SET<TEL.PHONEMAIL>  | 0-3 | Req |
| PRLO_MT202014CA.DirectAuthorityOver  Business name: i:contactable through Identifies the various means by which the location may be contacted and the types of contacts that exist. Effectively acts as a mini-yellow pages or directory for the service delivery location. Locations will frequently need to be reached to ask questions, schedule appointments, etc. They may also need to direct patients to reach the location. This is handled as a separate component because many larger facilities have numerous functions. The contact information for emergency is not the same as the contact for admitting or the finance department. |
|---|
typeCode : "DIRAUTH" (RoleLinkType) | 1 | Mand | | contactParty : ContactParty | 1 | Pop |
|
PRLO_MT202014CA.IdentifiedLocation  Business name: *k:has Provides additional identifiers by which the location may be known. In a registry, it is often necessary to link a location record to other registries or to commonly used jurisdictional identifiers. |
|---|
classCode : "IDENT" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Identifier An identifier by which the location is known. Specifies the actual identifier that can be used for searching or linking. The attribute is mandatory because there is no point specifying an "Other Identifiers" class if you are not going to specify an identifier. | 1 | Mand | code : (LocationIdentifiedEntityRoleType)  Business name: B:Identifier Type Specifies the kind of identifier being communicated. For example, billing identifier, regional identifier, public health identifier, etc. Provides context around the appropriate use for the identifier and is therefore mandatory. | 1 | Mand | | assigningIdentifierOrganization : IdentifierOrganization | 1 | Mand |
| PRLO_MT202014CA.IdentifierOrganization  Business name: Other Identifiers Describes additional identifiers for this service delivery location by which it may be queried or reported on. Allows a source delivery location to be identified with more than one identifier for linking or historical purposes. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C: Identifying Organization This is the name of the organization which issued and/or uses the identifier for the location. Further qualifies how the identifier is intended to be used. For example distinguishing a health-region assigned identifier from a provincially-assigned identifier. Because it is important to understanding the identifier, the attribute is mandatory. | 1 | Mand |
|
| |
PRLO_MT202014CA.Organization  Business name: B:Responsible Organization The organization responsible for the operations of the service delivery location. To provide additional information regarding the management and administration of the service delivery location. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: A: Responsible Organization Identifier Unique identifier for the responsible organization. The expectation is that these identifiers can be retrieved from jurisdictional provider registries. Where organization identifiers are not maintained in the registry, they may be omitted or alternative identifier sources may be used (e.g. identifiers issued by health regions). Allows drilling down for additional information about the organization. May also be used as a query parameter. | 0-1 | Req | name :  Business name: B: Responsible Organization Name The label by which the responsible organization is known and communicated with e.g. Capital Health District. Provides a user-accessible label for the organization and is therefore mandatory. | 1 | Mand |
| PRLO_MT202014CA.Part  Business name: m:contains Identifies component service delivery locations within the parent location. E.g. Buildings within a campus, wards within a building, etc. Allows for drill-down as well as providing context about the capabilities of the parent service delivery locaiton. |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | subLocation : SubLocation | 1 | Pop |
|
PRLO_MT202014CA.Part2  Business name: l:part of Identifies a location of which this location is a part. Allows a query response to return multiple levels of information when describing a location. For example "Emergency Ward at Good Health Hospital". The recursion depth is restricted to 1 I.e. nesting only one level |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| | PRLO_MT202014CA.Place |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: E:Location Place Type Distinguishes different levels of location granularity. E.g. Campus, building, floor, ward, room, bed. Used for searching, as well as for understanding what is meant by a particular location and is therefore mandatory. | 1 | Mand | mobileInd :  Business name: F:Location Mobile Indicator An indication of whether a place has the capability to move from one location to another. Example: air and ground ambulances, mobile clinics. Allows flagging that the location does not have a fixed physical location. This element must always be known and is therefore mandatory. | 1 | Mand | | asIdentifiedLocation : IdentifiedLocation | 0-5 | Req |
|
PRLO_MT202014CA.ServiceDefinition  Business name: Available Services A list of available services provided by the service delivery location. Useful when searching for a location to provide a particular service. May be used to filter query responses. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | code : (ActServiceDeliveryLocationService)  Business name: A: Service Type Describes the kind of health-related service being offered. This is the attribute that defines what the service is and is therefore mandatory. | 1 | Mand | statusCode : (x_ActStatusActiveSuspended)  Business name: B: Service Availability Indicates the availability of the health-related service within the location (as known by the registry/repository). e.g. active (currently offered), suspended (may have been offered in the past and may again be offered in the future, but not available right now). Services may not be always available; it is important to know whether a service is currently available when making decisions about where to send a patient. Because not all jurisdictions will support capturing availability time, this element is being made optional. | 0-1 | Opt | activityTime : SET<PIVL<TS.FULLDATETIME>>  Business name: C: Service Availability Time Specifies the time that a specific service is generally available. E.g. 8am to 7pm, Monday through Friday. Allows for a greater level of detail on service availability, i.e. hours of operation of a specific service at this location. We'd like this to be String, but need a datatype change to make that possible. | 0-1 | Req |
| PRLO_MT202014CA.ServiceDeliveryLocation  Business name: Location Any location where health-related services may be provided. Note that a single physical place can play multiple service delivery location roles e.g. a Podiatry clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number. Provides location information which uniquely identifies where health services are provided. This includes details and other supporting information on locations e.g. name, address, organization and contact parties. Needed when looking up facilities to link to patient records. Also useful when trying to find facilities to meet particular patient needs, as well as looking up how to contact the location. At least one of address or coordinate must be specified unless the place is mobile. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Location Type Identifies the type of Location represented by this record. For example, a service delivery location may be either an incidental service delivery location (a place at which health-related services may be provided without prior designation or authorization such as a church or school) or a dedicated service delivery location (a place that is intended to house the provision of health-related services such as a clinic or hospital). Dedicated service delivery locations can be further characterized as either clinical or non-clinical. Location Type is used for searching and for organizing Location records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | name : SET<TN>  Business name: D:Location Names A textual name for the place where the service is provided e.g. Ottawa General Hospital. Provides a human-readable label for the location. The location name is not intended to be parsed or analyzed by when processing the record. (E.g. To determine if a location is a hospital, look at the location type, don't check the name for the word "hospital".) Multiple repetitions are allowed to capture historical names | 0-5 | Req | addr : AD.BASIC  Business name: G:Location Address Identifies the physical address for this service delivery location, I.e. What is the geographic location of the building. For mobile service delivery location, this can either be set to the address of the "home" site for the mobile unit or can be set to a null flavor of N/A. Allows location to be visited. May also be used for geographic profiling (e.g. a dispatcher may be looking for the closest hospital or ambulance that can help a patient in need of emergency care). Because a physical address may not exist for mobile locations, and may not be expressible for non-dedicated locations such as water resevoirs, this element is only 'populated'. When no address exists, the null flavor should be set to NA. Restricted to physical address only | 1 | Pop | statusCode : (ServiceDeliveryRoleStatus)  Business name: C: Location Status This identifies the current state of the Location record. Allowed status values are 'active' (the location is actively used to deliver healthcare-related services), 'suspended' (the location has temporarily ceased delivering healthcare-related services) and 'terminated' (the location has permanently ceased delivering healthcare-related services and may no longer physically exist.) Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Location record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | | location : Place | 1 | Mand | | serviceProviderOrganization : Organization | 0-1 | Req | | subjectOf : Subject | 0-5 | Opt | | locationOf : Location | 0-100 | Req | | directAuthorityOver : DirectAuthorityOver | 0-100 | Req | | part : Part | 0-100 | Req | | indirectAuthority : IndirectAuthorithyOver | 1 | Pop | | partOf : Part2 | 0-1 | Req |
|
PRLO_MT202014CA.SubLocation  Business name: Sub-Locations Identifies service delivery locations contained within the described "parent" service delivery location. Allows a more thorough understanding of the capabilities of the service delivery location, as well as drill-down to component parts. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Sub-Location Identifier Unique identifier for the contained service delivery location Allows subsequent queries to drill down to detail information about this specific sub location and is therefore mandatory. | 1 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Sub-Location Type Describes the 'type' of component service delivery location. For example, a hospital might contain a laboratory or a community clinic. Provides context about what the capabilities of the component service delivery location are. Allows for unique identification of a sub-location and is therefore mandatory. | 1 | Mand | name : TN  Business name: Location Name A descriptive name for the sub-location. Provides a human-readable label for the location and is therefore mandatory. In general, names of sub-locations will be unique within their containing location. | 1 | Mand | | location : SubPlace | 1 | Mand |
| | PRLO_MT202014CA.SubPlace |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: D: Sub-Location Place Type Identifies the physical type of the component location. For example, a campus may contain a building, a building may contain a ward, etc. Provides context about the type of sub-location. Used for searching, as well as for understanding what is meant by a particular sub-location and is therefore mandatory. | 1 | Mand |
|
| | PRLO_MT202014CA.TerritorialAuthority |
|---|
classCode : "TERR" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: H: Location Region Id Identifies the health region associated with the service delivery location (if any). In Canada, many service delivery locations are organized into regions for administrative, coordination and/or funding reasons. Regions may influence where a patient may go for services. They may also be used for searching. Because not all service delivery locations are associated with a region, this element is only 'populated' to allow null flavors such as 'NA'. | 1 | Pop |
|
|
|
|
|---|
PRLO_MT202015CA.ContactParty  |
|---|
classCode : "CON" (RoleClass) | 1 | Mand | code : (AdministrativeContactRoleType)  | 1 | Mand | addr : AD.BASIC  | 0-1 | Req | telecom : SET<TEL.PHONEMAIL>  | 0-3 | Req |
| PRLO_MT202015CA.DirectAuthorityOver  Business name: i:contactable through Identifies the various means by which the location may be contacted and the types of contacts that exist. Effectively acts as a mini-yellow pages or directory for the service delivery location. Locations will frequently need to be reached to ask questions, schedule appointments, etc. They may also need to direct patients to reach the location. This is handled as a separate component because many larger facilities have numerous functions. The contact information for emergency is not the same as the contact for admitting or the finance department. |
|---|
typeCode : "DIRAUTH" (RoleLinkType) | 1 | Mand | | contactParty : ContactParty | 1 | Pop |
|
PRLO_MT202015CA.IdentifiedLocation  Business name: *k:has Provides additional identifiers by which the location may be known. In a registry, it is often necessary to link a location record to other registries or to commonly used jurisdictional identifiers. |
|---|
classCode : "IDENT" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Identifier An identifier by which the location is known. Specifies the actual identifier that can be used for searching or linking. The attribute is mandatory because there is no point specifying an "Other Identifiers" class if you are not going to specify an identifier. | 1 | Mand | code : (LocationIdentifiedEntityRoleType)  Business name: B:Identifier Type Specifies the kind of identifier being communicated. For example, billing identifier, regional identifier, public health identifier, etc. Provides context around the appropriate use for the identifier and is therefore mandatory. | 1 | Mand | | assigningIdentifierOrganization : IdentifierOrganization | 1 | Mand |
| PRLO_MT202015CA.IdentifierOrganization  Business name: Other Identifiers Describes additional identifiers for this service delivery location by which it may be queried or reported on. Allows a source delivery location to be identified with more than one identifier for linking or historical purposes. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | name :  Business name: C: Identifying Organization This is the name of the organization which issued and/or uses the identifier for the location. Further qualifies how the identifier is intended to be used. For example distinguishing a health-region assigned identifier from a provincially-assigned identifier. Because it is important to understanding the identifier, the attribute is mandatory. | 1 | Mand |
|
| |
PRLO_MT202015CA.Organization  Business name: B:Responsible Organization The organization responsible for the operations of the service delivery location. To provide additional information regarding the management and administration of the service delivery location. |
|---|
classCode : "ORG" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | id : II.BUS  Business name: A: Responsible Organization Identifier Unique identifier for the responsible organization. The expectation is that these identifiers can be retrieved from jurisdictional provider registries. Where organization identifiers are not maintained in the registry, they may be omitted or alternative identifier sources may be used (e.g. identifiers issued by health regions). Allows drilling down for additional information about the organization. May also be used as a query parameter. | 0-1 | Req | name :  Business name: B: Responsible Organization Name The label by which the responsible organization is known and communicated with e.g. Capital Health District. Provides a user-accessible label for the organization and is therefore mandatory. | 1 | Mand |
| PRLO_MT202015CA.Part  Business name: m:contains Identifies component service delivery locations within the parent location. E.g. Buildings within a campus, wards within a building, etc. Allows for drill-down as well as providing context about the capabilities of the parent service delivery locaiton. |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | subLocation : SubLocation | 1 | Pop |
|
PRLO_MT202015CA.Part2  Business name: l:part of Identifies a location of which this location is a part. Allows a query response to return multiple levels of information when describing a location. For example "Emergency Ward at Good Health Hospital". The recursion depth is restricted to 1 I.e. nesting only one level |
|---|
typeCode : "PART" (RoleLinkType) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
PRLO_MT202015CA.ServiceDefinition  Business name: Available Services A list of available services provided by the service delivery location. Useful when searching for a location to provide a particular service. May be used to filter query responses. |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | code : (ActServiceDeliveryLocationService)  Business name: A: Service Type Describes the kind of health-related service being offered. This is the attribute that defines what the service is and is therefore mandatory. | 1 | Mand | statusCode : (x_ActStatusActiveSuspended)  Business name: B: Service Availability Indicates the availability of the health-related service within the location (as known by the registry/repository). e.g. active (currently offered), suspended (may have been offered in the past and may again be offered in the future, but not available right now). Services may not be always available; it is important to know whether a service is currently available when making decisions about where to send a patient. Because not all jurisdictions will support capturing availability time, this element is being made optional. | 0-1 | Opt | activityTime : SET<PIVL<TS.FULLDATETIME>>  Business name: C: Service Availability Time Specifies the time that a specific service is generally available. E.g. 8am to 7pm, Monday through Friday. Allows for a greater level of detail on service availability, i.e. hours of operation of a specific service at this location. We'd like this to be String, but need a datatype change to make that possible. | 0-1 | Req |
| PRLO_MT202015CA.ServiceDeliveryLocation  Business name: Location Any location where health-related services may be provided. Note that a single physical place can play multiple service delivery location roles e.g. a Podiatry clinic and Research clinic may meet on alternate days in the same physical location; each clinic uses its own mailing address and telephone number. Provides location information which uniquely identifies where health services are provided. This includes details and other supporting information on locations e.g. name, address, organization and contact parties. Needed when looking up facilities to link to patient records. Also useful when trying to find facilities to meet particular patient needs, as well as looking up how to contact the location. At least one of address or coordinate must be specified unless the place is mobile. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A: Location Identifiers A globally unique identifier assigned by the EHR to the Location record. Allows for unique identification of the Location and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 2 | Mand | name : SET<TN>  Business name: D:Location Names A textual name for the place where the service is provided e.g. Ottawa General Hospital. Provides a human-readable label for the location. The location name is not intended to be parsed or analyzed by when processing the record. (E.g. To determine if a location is a hospital, look at the location type, don't check the name for the word "hospital".) Multiple repetitions are allowed to capture historical names | 0-5 | Req | addr : AD.BASIC  Business name: G:Location Address Identifies the physical address for this service delivery location, I.e. What is the geographic location of the building. For mobile service delivery location, this can either be set to the address of the "home" site for the mobile unit or can be set to a null flavor of N/A. Allows location to be visited. May also be used for geographic profiling (e.g. a dispatcher may be looking for the closest hospital or ambulance that can help a patient in need of emergency care). Because a physical address may not exist for mobile locations, and may not be expressible for non-dedicated locations such as water resevoirs, this element is only 'populated'. When no address exists, the null flavor should be set to NA. Restricted to physical address only | 1 | Pop | statusCode : (ServiceDeliveryRoleStatus)  Business name: C: Location Status This identifies the current state of the Location record. Allowed status values are 'active' (the location is actively used to deliver healthcare-related services), 'suspended' (the location has temporarily ceased delivering healthcare-related services) and 'terminated' (the location has permanently ceased delivering healthcare-related services and may no longer physically exist.) Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Location record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | | location : Place | 0-1 | Req | | serviceProviderOrganization : Organization | 0-1 | Req | | subjectOf : Subject | 0-5 | Opt | | locationOf : Location | 0-100 | Req | | directAuthorityOver : DirectAuthorityOver | 0-100 | Req | | part : Part | 0-100 | Req | | indirectAuthority : IndirectAuthorithyOver | 1 | Pop | | partOf : Part2 | 0-1 | Req |
|
PRLO_MT202015CA.SubLocation  Business name: Sub-Locations Identifies service delivery locations contained within the described "parent" service delivery location. Allows a more thorough understanding of the capabilities of the service delivery location, as well as drill-down to component parts. |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Sub-Location Identifier Unique identifier for the contained service delivery location Allows subsequent queries to drill down to detail information about this specific sub location and is therefore mandatory. | 1 | Mand | code : (ServiceDeliveryLocationRoleType)  Business name: B: Sub-Location Type Describes the 'type' of component service delivery location. For example, a hospital might contain a laboratory or a community clinic. Provides context about what the capabilities of the component service delivery location are. Allows for unique identification of a sub-location and is therefore mandatory. | 1 | Mand | name : TN  Business name: Location Name A descriptive name for the sub-location. Provides a human-readable label for the location and is therefore mandatory. In general, names of sub-locations will be unique within their containing location. | 1 | Mand | | location : SubPlace | 1 | Mand |
| | PRLO_MT202015CA.SubPlace |
|---|
classCode : "PLC" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | code : (ServiceDeliveryLocationPlaceType)  Business name: D: Sub-Location Place Type Identifies the physical type of the component location. For example, a campus may contain a building, a building may contain a ward, etc. Provides context about the type of sub-location. Used for searching, as well as for understanding what is meant by a particular sub-location and is therefore mandatory. | 1 | Mand |
|
| | PRLO_MT202015CA.TerritorialAuthority |
|---|
classCode : "TERR" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: H: Location Region Id Identifies the health region associated with the service delivery location (if any). In Canada, many service delivery locations are organized into regions for administrative, coordination and/or funding reasons. Regions may influence where a patient may go for services. They may also be used for searching. Because not all service delivery locations are associated with a region, this element is only 'populated' to allow null flavors such as 'NA'. | 1 | Pop |
|
|
|
|
|---|
QUQI_MT020000CA.Author  Business name: a:*created by Indicates the person responsible for the event that caused this message. Choice of Patient CMET is as follows: Critical for auditing and for validating permissions and therefore mandatory. |
|---|
typeCode : "AUT" (ParticipationType)  Value should always be AUT | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: D:Time of Creation The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.) This date can be back-dated. The time a change is made is a critical piece of audit information and is therefore mandatory. | 1 | Mand | modeCode : (ParticipationMode)  Business name: F:Information Received Method Indicates how the person who recorded the event became aware of it.. E.g. Verbal, written, fax, etc. May have ramifications for the audit trail and reliability of the information. | 0-1 | Req | signatureText : ED.SIGNATURE  Business name: G:Digital Signature Indicates the formal digital signature of the message content. Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. | 0-1 | Opt | | Choice: authorPerson : AuthorPerson | 1 | Pop | | »» 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 |
| |
QUQI_MT020000CA.AuthorRole  Business name: Null Author Role This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token. |
|---|
classCode : (RoleClass) | 1 | Mand |
| QUQI_MT020000CA.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. |
|---|
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 |
|
QUQI_MT020000CA.Component  Business name: Care Compositions A care composition is a record, which summarizes the events that happened during care including who is responsible for the care provided. Examples include encounters, health condition (episode)-based collections and general care-based collections such as "gynecological care". Allows linking records to encounters, condition and care-based compositions. Useful for searching and navigation of the patient's record. |
|---|
typeCode : (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd :  | 1 | Mand | | patientCareProvisionEvent : PatientCareProvisionEvent | 1 | Pop |
| QUQI_MT020000CA.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.FULLDATE>  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 | | recordTarget : RecordTarget | 1 | Mand | | responsibleParty : ResponsibleParty | 0-1 | Opt | | author : Author | 0-1 | Opt | | dataEnterer : DataEnterer | 0-1 | Opt | | dataEntryLocation : DataEntryLocation | 0-1 | Opt | | location : Location | 0-1 | Opt | | pertinentInformation : PertinentInformation | 0-1 | Opt | | subjectOf1 : Subject | 0-50 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | componentOf : Component | 0-100 | Req | | queryByParameter : QueryByParameter | 1 | Mand |
|
QUQI_MT020000CA.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. |
|---|
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 |
| QUQI_MT020000CA.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. |
|---|
typeCode : "ELOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
QUQI_MT020000CA.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. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| | QUQI_MT020000CA.QueryByParameter |
|---|
queryId : II.TOKEN  Business name: H:Query Identifier Unique number for this particular query. Needed to allow continuation of queries and linking of query requests and responses and therefore mandatory. | 1 | Mand | initialQuantity : INT.POS  Business name: I:Query Limit The number of response item repetitions that should be included in the initial response. If not specified, the default behavior is to return all repetitions. However the recipient of a query may always choose to limit the quantity returned to be less than the number requested. Regardless of the number specified here, the number of rows returned will never exceed the number of matching rows based on the query parameters. There may be a very large number of matching rows. To manage communication bandwidth, a limited set may initially be returned with further data retrieved by using query continuations. | 0-1 | Req | initialQuantityCode : (QueryRequestLimit)  Business name: J:Query Limit Type Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application. Needed to quantify the types of records requested to be returned in the query. | 0-1 | Req | parameterList :  | 1 | Mand |
|
QUQI_MT020000CA.RecordTarget  Associated patient record for which this message applies. Record target can be one of either identified patient (id, name, gender, date of birth), indeterminate patient (name, gender, date of birth) or a patient token (suggesting client identity). Inferring patient identity opens up the potential for privacy breach through the mis-keying of identifiers. Also, inclusion of patient identity simplifies logging, processing and application of data access constraints such as masking and consent. Finally, patient id is required to support both EHR Index (record and update) and Patient Profile Summary query (list). Patient identity is key to successful operation of the EHR. A bare identifier exposes the patient to potential privacy violation. |
|---|
typeCode : (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: patient1 : Patient | 1 | Mand | | »» patient1 : Patient | 0-1 | Opt | | »» patient2 : Patient | 0-1 | Opt | | »» patient3 : Patient | 0-1 | Opt |
| QUQI_MT020000CA.ResponsibleParty  Business name: supervised by Allows for the trail of responsibility for the action. The association is optional because in some jurisdictions, the supervisor may be conveyed by he authentication token. 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 |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | assignedEntity : AssignedEntity | 1 | Pop |
|
| QUQI_MT020000CA.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 |
|
|
|
|
|---|
QUQI_MT120006CA.Component  Business name: Care Compositions A care composition is a record, which summarizes the events that happened during care including who is responsible for the care provided. Examples include encounters, health condition (episode)-based collections and general care-based collections such as "gynecological care". Allows linking records to encounters, condition and care-based compositions. Useful for searching and navigation of the patient's record. |
|---|
typeCode : (ActRelationshipType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | contextConductionInd :  | 1 | Mand | | patientCareProvisionEvent : PatientCareProvisionEvent | 1 | Pop |
| QUQI_MT120006CA.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.FULLDATE>  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 | | recordTarget : RecordTarget | 1 | Mand | | subject : Subject2 | 0-1000 | Req | | subjectOf1 : Subject | 0-50 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | targetOf : Component | 0-100 | Req | | queryAck : QueryAck | 1 | Mand | | queryByParameter : QueryByParameter | 1 | Mand |
|
| | QUQI_MT120006CA.QueryAck |
|---|
queryId : II.TOKEN  Business name: H:Query Identifier Identifies the query being acknowledged Allows linking of a response back to the request that triggered it and is therefore mandatory. Particularly useful when responses are deferred or queued. | 1 | Mand | queryResponseCode : (QueryResponse)  Business name: I:Query Status Indicates whether the query was successful or not. Used to control receiver logic and is therefore mandatory. | 1 | Mand | resultTotalQuantity : INT.NONNEG  Business name: J:Total Matching Rows Identifies the total number of rows identified that matched the query. Indicates the overall size of the result-set and is therefore mandatory. Particularly useful when only part of the result set is actually returned. | 1 | Mand | resultCurrentQuantity : INT.NONNEG  Business name: K:Returned Rows Identifies the number of rows returned as part of this particular query response. Provides a quick overview of the results of the query and is therefore mandatory. | 1 | Mand | resultRemainingQuantity : INT.NONNEG  Business name: L:Remaining Rows Indicates the number of rows that still exist after the last row returned in this response. Identifies how much data remains to be queried and is therefore mandatory. | 1 | Mand |
|
| QUQI_MT120006CA.QueryByParameter |
|---|
queryId : II.TOKEN  Business name: H:Query Identifier Unique number for this particular query. Needed to allow continuation of queries and linking of query requests and responses and therefore mandatory. | 1 | Mand | initialQuantity : INT.POS  Business name: I:Query Limit The number of response item repetitions that should be included in the initial response. If not specified, the default behavior is to return all repetitions. However the recipient of a query may always choose to limit the quantity returned to be less than the number requested. Regardless of the number specified here, the number of rows returned will never exceed the number of matching rows based on the query parameters. There may be a very large number of matching rows. To manage communication bandwidth, a limited set may initially be returned with further data retrieved by using query continuations. | 0-1 | Req | initialQuantityCode : (QueryRequestLimit)  Business name: J:Query Limit Type Defines the units associated with the magnitude of the maximum size limit of a query response that can be accepted by the requesting application. Needed to quantify the types of records requested to be returned in the query. | 0-1 | Req | parameterList :  | 1 | Mand |
| QUQI_MT120006CA.RecordTarget  Associated patient record for which this message applies. Record target can be one of either identified patient (id, name, gender, date of birth), indeterminate patient (name, gender, date of birth) or a patient token (suggesting client identity). Inferring patient identity opens up the potential for privacy breach through the mis-keying of identifiers. Also, inclusion of patient identity simplifies logging, processing and application of data access constraints such as masking and consent. Finally, patient id is required to support both EHR Index (record and update) and Patient Profile Summary query (list). Patient identity is key to successful operation of the EHR. A bare identifier exposes the patient to potential privacy violation. |
|---|
typeCode : (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: patient1 : Patient | 1 | Mand | | »» patient1 : Patient | 0-1 | Opt | | »» patient2 : Patient | 0-1 | Opt | | »» patient3 : Patient | 0-1 | Opt |
|
| QUQI_MT120006CA.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 : (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl)  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. | 1 | Mand | contextConductionInd :  | 1 | Mand | act :  | 1 | Pop |
|
QUQI_MT120006CA.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 |
|
|
|
|
|---|
| REPC_DM200000CA.ActRequest  Business name: Request A particular request (referral or specific request) that resulted in the creation of the Clinical Document. There are several pieces of information about a request that may influence understanding of the record including when requested, by whom, why, etc. |
|---|
classCode : (x_ActClassCareProvisionEncounter)  Business name: B: Request Type This distinguishes between "referral" requests and specific orders. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Clinical Document Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Request id This identifies the specific request record (referral or order) that this Clinical Document is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author3 | 0-1 | Req |
|
| REPC_DM200000CA.ActRequest2 |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActProfessionalServiceCode)  Business name: H:Requested Service Acoded value denoting the specific service taht has been order through the referral. Helps to reconcile to service that is subsequently performed. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Requested Service 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 |
| |
REPC_DM200000CA.AssignedEntity  Business name: Provider Identifies the service provider or type of service provider who is being requested to deliver services to the patient. Represents a key piece of information about the referral. Included because the referral may be routed to a different person than that intended to actually deliver the service. Player association must be present if and only if id is present |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II.BUS  Business name: F: Provider Id A unique provider identifier such as the MINC #; (a unique lifetime identifier for physicians in Canada). Other health care professions such as nursing and dietitians have similar identifiers. For those providers (such as family members, friends, neighbors and others who are part of the patient's informal support network will not have identifiers) the system will assign identifiers for the purpose of linking information within the message. An identifier is the best way of kinking a provider to information in a provider registry, and therefore will be required in the absence of a provider name. For non-professional providers and others who do not have unique provider numbers, applications must create 'internal' identifiers to allow referencing of the provider within the message. | 0-1 | Req | code : (HealthcareProviderRoleType)  Business name: G: Provider Type Indicates the medical discipline of the provider. Provides important context to understanding information recorded by a provider and work intended to be performed by the provider. | 0-1 | Req | | assignedProvider : Provider | 0-1 | Req |
| REPC_DM200000CA.Author  Business name: *a: authored by This identifies the provider who is responsible for the decision to capture the Clinical Document in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: X: Authored Datetime Indicates the time the decision to record when the Clinical Document was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | signatureCode : (ParticipationSignature)  Business name: K:Attested Indicator An indication that the provider attests to the authenticity of the document that he/she has authored. Important for assessing the level of 'officialness' of a document. Because it must always be known whether a document has been attested or not, 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 |
|
| |
| |
| REPC_DM200000CA.Component3 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | | section : Section | 1 | Mand |
| |
| REPC_DM200000CA.Component5 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
| |
| REPC_DM200000CA.Component7 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
| |
REPC_DM200000CA.ConditionEvent  Business name: Discharge Diagnoses Describes one of the conditions associated with the patient as part of the encounter. Commonly used for reporting, but also useful for searching and for obtaining a general understanding of the encounter. |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (ActCode)  Business name: A: Discharge Diagnosis Type Identifications of the type of diagnosis at the time of discharge. For SNOMED, the complete diagnosis appears here. For non-SNOMED this should be a fixed value of "DX". The diagnosis is core information around which the care provision revolves, therefore this is a mandatory attribute. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | value : (DiagnosisValue)  Business name: B:Diagnosis Code Identifies the actual discharge diagnosis. Provides context into the result of the care provision. The attribute is optional because for systems that support SNOMED, this concept will be communicated as part of the Discharge Diagnosis Type | 0-1 | Opt |
| |
| REPC_DM200000CA.Document  Business name: Clinical Document Represents a particular health-related document pertaining to a single patient. Allows the capture of patient health data in an encapsulated, contextualized manner with capability of displaying rendered content and communication between simple systems. Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
classCode : "DOCCLIN" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A: Document Identifier A globally unique identifier assigned by the EHR to the Clinical Document record. Allows for unique identification of the Clinical Document and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 0-2 | Opt | code : (DocumentType)  Business name: B: Document Category Identifies the type of Clinical Document represented by this record. e.g. referral, consult note, clinical summary. Document Category is used for searching and for organizing Clinical Document records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | title :  Business name: J: Document Title A human-readable label for this particular document. Titles do not necessarily need to be unique, but should be precise-enough to give a pretty good idea of what the document contains. For example "Right Knee Arthroscopy Report, Jan 3, 2006" would represent a good title. "Surgery Report" would not. This is a human-recognizable name intended to be displayed on the screen in list transactions and is therefore mandatory. It provides a good indication of the content of the document at a quick glance. | 1 | Mand | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: E: Document Masking Indicators Communicates the desire of the patient to restrict access to this Clinical Document 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | | responsibleParty : ResponsibleParty | 1 | Mand | | author : Author | 1 | Mand | | informant : Informant | 0-1 | Req | | custodian1 : Custodian2 | 1 | Mand | | custodian2 : Custodian | 1 | Mand | | primaryInformationRecipient : InformationRecipient | 0-10 | Req | | predecessor : Predecessor2 | 0-10 | Req | | component : Component2 | 1 | Mand | | successor : Predecessor | 0-1 | Req | | subjectOf1 : Subject4 | 0-1 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | componentOf : Component6 | 0-100 | Req |
|
| |
| |
| |
| REPC_DM200000CA.Location2  Business name: i:occurred at This identifies the location where the actual discharge/care event occurred. E.g. Patient's residence, clinic, work site, hospital, etc. It only needs to be specified when the occurrence location differs from the official record location. The site of the actual event provides context for interpreting the record. In some cases, it may also provide follow-up information The site of the actual event provides context for interpreting the record. In some cases, it may also provide follow-up information |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
REPC_DM200000CA.Location3  Business name: v:referred to Indicates the service Delivery Location where the referral service is targeted to be preformed. The target site of the referral service provides context for interpreting the record. In some cases, it may also provide follow-up information If the referral was targeted to a service delivery location then the identity of the location must be known. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
REPC_DM200000CA.Observation  Business name: A: Clinical Observation Document Discrete information about the observation or procedure or other report or note being written Provides contextual overview information for searching and filtering |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (ClinicalReportDocumentType)  Business name: C: Clinical Observation Document Type Identifies the type of Clinical Document represented by this record. e.g. family history, environmental history, social history, etc. Clinical Observation Document Type is used for searching and for organizing Clinical Document records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.DATE>  Business name: F: Clinical Observation Document Time Range Indicates the period of time over which the assessment described by the clinical note applies. If the assessment applies over the entire life of the patient, only the end date (the point up to which the assessment is current) needs to be specified. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 1 | Pop | | location : Location | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf3 | 0-1 | Req | | subject : Subject | 0-1 | Req |
| REPC_DM200000CA.ObservationRequest  Business name: Request A particular request (referral or specific request) that resulted in the creation of the Clinical Document. There are several pieces of information about a request that may influence understanding of the record including when requested, by whom, why, etc. |
|---|
classCode : (x_ActClassCareProvisionObservation)  Business name: B: Request Type This distinguishes between "referral" requests and specific orders. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Clinical Document Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: A: Request Id This identifies the specific request record (referral or order) that this Clinical Document is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author2 | 0-1 | Req |
|
| |
REPC_DM200000CA.PatientCareProvisionEvent  Business name: B: Discharge/Care Summary Report Discrete information about the encounter, episode or other event for which the discharge or care report is being written. Provides contextual overview information for searching and filtering |
|---|
classCode : "ENC" (ActClass)  Need to change classCode to PCPR as soon as encounter is made a specialization and discharge disposition is moved up. | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: M:Reported on Care Composition Link Provides the identifier of the discrete encounter, episode or care event being reported on. Allows for drill-down and for direct association between the report and the discrete record. | 0-1 | Req | code : CD (ActCareEventType)  Business name: C: Discharge/Care Summary Report Type Identifies the type or category Summary Report represented by this record. The discharge / care report summarizes the events and activities that happened during care including who is responsible for the care provided. The report is sent at the termination of care. In this case, the performer is the sending provider. Examples: Inpatient stay, cardiology, etc. Discharge/Care Summary Report Type is used for searching and for organizing Clinical Document records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : (x_ActStatusActiveComplete)  Business name: D: Preliminary/Final Indicator This identifies the current state of the Clinical Document record. If the status is 'active' it means that the assessment is ongoing and the report is preliminary. If the status is 'completed' it means that the assessment is finished and the report is considered complete. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Clinical Document record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATETIME>  Business name: F: Discharge/Care Summary Report Period Indicates the period of care to which the discharge or care report applies. For an encounter discharge assessment, this would be the admit and discharge date. Identifies the time-period of relevance to the record which is useful in filtering and organizing "time-view" presentations of data. Because the period covered by a discharge or care summary should always be known, this attribute is mandatory. | 1 | Mand | dischargeDispositionCode : (EncounterDischargeDisposition)  Business name: N:Discharge Disposition Indicates the manner in which the patient left the encounter or other care event. E.g. 'Deceased', 'Discharged to home', 'Discharged to isolation' May be important in planning subsequent care for the patient. Something must be said about discharge condition but in some circumstances the value may not be known. Thus the attribute is treated as 'populated'. | 1 | Pop | | location : Location2 | 0-1 | Req | | outcome : Outcome | 0-100 | Req | | inFulfillmentOf : InFulfillmentOf | 0-1 | Req |
| | REPC_DM200000CA.PatientCareProvisionEvent2 |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: N: Referral Report Link A unique identifier for the report resulting from the action requested by this referral. This linkage may be established after the document has been created if the report provides a direct link to the referral. Provides a direct link between the referral and the resulting report. | 0-1 | Req |
|
REPC_DM200000CA.PatientCareProvisionRequest  Business name: C:Referral Discrete information about the type of care being requested. Provides contextual overview information for searching and filtering |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActCareProvisionRequestType)  Business name: C: Referral Type Concepts identifying different types of referral request document. These codes identify the general type of care services requested. They are not used to represent the indication or diagnosis which triggered the need for the referral. Referral Type is used for searching and for organizing Clinical Document records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : (x_ActStatusActiveComplete)  Business name: D: Referral Status This identifies the current state of the Clinical Document record. If the status is 'active' it means the request is still outstanding or in progress. If the status is 'complete' it means that the referral has been acted upon and the referral is considered closed. If the status is 'aborted' it means the request made by the referral has been withdrawn. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Clinical Document record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. It is important to note that the EHR is not expected to perform status management of referrals. Thus it is up to clinicians to amend the status of a referral when it has changed to complete. | 0-1 | Req | effectiveTime : IVL.LOW<TS.DATE>  Business name: F: Referral Requested By Time Indicates the target date by which the referring provider hopes the requested assessment could be completed. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. Identifies the time-period of relevance to the record which is useful in filtering and organizing "time-view" presentations of data. | 0-1 | Req | | performer : Performer | 0-1 | Req | | location : Location3 | 0-1 | Req | | component : Component8 | 0-1 | Req | | fulfillment : InFulfillmentOf2 | 0-1 | Req |
| |
| |
| |
| | REPC_DM200000CA.Reference |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: L:Reference Record Links These identifiers allow for referencing other discrete records within the EHR which are considered relevant to the document as a whole or a particular section. For sections, the links may refer specifically to records which have been rendered as part of the section. The external references allow accessing discrete data for additional analysis and manipulation such as graphing, automated comparison or decision-support. | 1 | Mand |
|
REPC_DM200000CA.ResponsibleParty  Business name: *b: supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Clinical Document. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| | REPC_DM200000CA.Section |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | text : ED.DOC  Business name: M: Document Overview Content Provides the primary rendered textual content of the document. E.g. The cover letter for a referral, the overview portion of a report, etc. There is no guidance provided within the standard on how report content should be organized or formatted. Guidance may be provided by professional colleges, specialty groups or others. Represents the principle content of the document and therefore is mandatory. | 1 | Mand | | component1 : Component4 | 1 | Mand | | component2 : Component | 0-100 | Req | | component3 : Component5 | 0-100 | Req |
|
| REPC_DM200000CA.SubSection  Business name: Document Sections Used to document additional relevant information about the patient such as allergies, medications, problem list, etc. Provides contextual information for understanding the Clinical Document by sharing a filtered, rendered view of portions of the patient's record. |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (DocumentSectionType)  Business name: A: Section Type Identifies the type of Clinical Document represented by this record. Examples: allergy list, problem list, medication list, etc. Section Type is used for searching and for organizing Clinical Document records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. The element uses CWE to allow for the capture of Section 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 | title :  Business name: B: Section Title Represents the label associated with this particular portion of the document. These are a human-readable equivalents to the Section Type code. E.g. "Allergies", "Assessment", "Recommendations", etc. Provides a human readable label for the section. Because it is used as part of the document rendering, the attribute is mandatory. | 1 | Mand | text : ED.DOC  Business name: M: Section Content Represents the rendered text content for the section. Provides a human-readable view of data that is accessible without sophisticated PoS applications. Allows data to be filtered and rendered in a manner to focus on the content deemed relevant by the author of the document. Because it coveys the content, the attribute mus be mandatory. | 1 | Mand | | component : Component7 | 0-100 | Req |
|
| |
|
|
|
|
|---|
| REPC_DM300000CA.Author  Business name: *a:authored by This identifies the provider who is responsible for the decision to capture the Health Condition in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. AllergyIntolerance.authorizingProvider ZPB1.3 AllergyIntolerance.authorizingPhysician |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Authored Datetime Indicates the time the decision to record when the Health Condition was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
REPC_DM300000CA.Author3  Business name: *last amended by This identifies the provider who most recently amended the Health Condition. The most recent Amending Provider has significant responsibility for the "current appearance" of the record and can have considerable influence on how other providers will interpret the validity and significance of the record. The element is mandatory because it should always be known by the EHR. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Amend Datetime This indicates the last time a change was made to the Health Condition. It can be used by PoS applications to sort or filter records. Also provides information on how recently the record has changed. Because the element should always be known by the EHR, it is mandatory. | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
REPC_DM300000CA.ConditionEvent  Business name: Health Condition A record of a patient's health condition, as tracked over time. Examples include diseases, disabilities, pregnancy, lactation and other clinical conditions of interest. Also known as "Problem" (from a 'problem list'). Necessary component of a person's overall profile. Helps with contraindication checking. Code is fixed DX if not using SNOMED; Code is fixed to 'Assertion' if using SNOMED |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A:Condition Identifier A globally unique identifier assigned by the EHR to the Health Condition record. The identifier applies to this "instance" of the condition. For example, multiple pregnancies would each be treated as distinct conditions, each with a unique id. Allows for unique identification of the Health Condition and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 0-2 | Opt | code : (ActCode)  Business name: B: Condition Type Designates the concept in DiagnosisValue as a Diagnosis Condition Type is used for searching and for organizing Health Condition records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. Since all diagnosis concepts can be represented in a single field, this domain is a fixed value | 1 | Mand | negationInd :  Business name: E: Refuted Indicator When set to true, specifically flags the Health Condition record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. | 1 | Mand | statusCode : (ActStatus)  Business name: C:Condition Status This identifies the current state of the Health Condition record. Indicates whether the condition is still being monitored as relevant to the patient's health ('active') or whether the condition is no longer considered a relevant 'problem' ('completed'). It may also be 'obsolete' in circumstances where the record has been replaced. Note that a problem may be considered 'active' even if the underlying condition is no longer affecting the patient. For example, for a patient who was recently pregnant, the pregnancy has ended, but the pregnancy would still be an 'active' condition record because of it's ongoing impact on the patient's healthcare situation. To convey the actual clinical status of the condition, use SNOMED post-coordination in the Condition attribute. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Health Condition record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATE>  Business name: G: Condition Time Period The date on which the condition first began and when it ended. For ongoing conditions such as chronic diseases, the upper boundary may be unknown. For transient conditions such as pregnancy, lactation, etc; the upper boundary of the period would usually be specified to signify the end of the condition. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 0-1 | Req | confidentialityCode : SET<CV> (x_NormalRestrictedTabooConfidentialityKind)  Business name: F: Condition Masking Indicators 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | value : CD (DiagnosisValue)  Business name: K:Condition A code indicating the specific condition. E.g. Hypertension, Pregnancy. This is the central piece of information in recording a condition, therefore the attribute is mandatory. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Condition 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 | | responsibleParty : ResponsibleParty | 1 | Mand | | author : Author | 1 | Mand | | informant : Informant | 0-1 | Req | | custodian1 : Custodian2 | 1 | Mand | | custodian2 : Custodian | 1 | Mand | | predecessor : Predecessor | 0-10 | Req | | replacementOf : ReplacementOf | 0-1 | Req | | successor : Predecessor2 | 0-1 | Req | | subjectOf1 : Subject | 0-1 | Req | | subjectOf2 : Subject3 | 0-100 | Req | | subjectOf3 : Subject7 | 0-1 | Req | | subjectOf4 : Subject6 | 0-1 | Req | | componentOf : Component | 0-100 | Req |
| REPC_DM300000CA.ControlActEvent  Business name: Amendment Summary Identifies information about the most recent change to the Health Condition including when it was made, by whom and why. Provides context information about the record. |
|---|
classCode : "CACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | reasonCode : (ControlActReason)  Business name: B:Amend Reason This indicates the reason for most recent amendment to the record as indicated by the person who made the change. Understanding the reason for the most recent amendment provides context for the current state of the record. The element uses CWE to allow for the capture of Amend Reason 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. | 0-1 | Req | | author : Author3 | 1 | Mand |
|
| |
| |
| |
| |
REPC_DM300000CA.ResponsibleParty  Business name: c:supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Health Condition. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| |
|
|
|
|
|---|
| REPC_DM400000CA.ActDefinition |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | id : II.BUS  Business name: E:Protocol Ids Indicates that the action described by the Common Observation record was performed as part of a particular protocol. Allows linking together a series of observations, procedures, drug administrations and other clinical actions as part of a particular protocol. Useful in clinical studies and may also provide context around why the action was performed. The element also allows providers to filter searches to only expose data related to a particular protocol. This element is optional because the use of and need to reference protocols will not apply to all healthcare providers. PoS applications should choose whether to support the element based on the perceived needs of their client base. | 1 | Mand |
| REPC_DM400000CA.ActRequest  Business name: Request A particular request (referral or specific request) that resulted in the creation of the Common Observation. There are several pieces of information about a request that may influence understanding of the record including when requested, by whom, why, etc. |
|---|
classCode : (x_ActClassCareProvisionObservation)  Business name: Request Type This distinguishes between "referral" requests and specific orders. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Common Observation Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: Request Id This identifies the specific request record (referral or order) that this Common Observation is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author2 | 0-1 | Req |
|
| |
REPC_DM400000CA.Author3  Business name: *a:authored by This identifies the provider who is responsible for the decision to capture the Common Observation in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. Annotation.requestingProvider ZPB3.18 (id.root) ZPB3.19 (id.extension) ZPB3.15 |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Authored Datetime Indicates the time the decision to record when the Common Observation was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. ZPB3.20 Annotation.annotationDate | 1 | Pop | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| REPC_DM400000CA.CommonObservationEvent  Business name: Common Observation This record expresses a single point-in-time observation made about a patient. Observations are a key mechanism for capturing the state of a patient. Observations provide context for interventions subsequently taken. Observations can also be tracked over time to look for changes that may help in assessing a patient's health. Annotation is only permitted if Annotation Indicator is not present and vice versa Observation Value must be specified and may only be specified when no sub-observations are present. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A:Observation Record Id A globally unique identifier assigned by the EHR to the Common Observation record. Allows for unique identification of the Common Observation and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 0-2 | Opt | code : CD (NonLabDIObservationType)  Business name: B:Observation Type Identifies the type of Common Observation represented by this record. Observation types include: height, weight, blood pressure, blood type, APGAR, etc. EPHS:Observation.code fixed to "OUTCOME" at runtime EPHS: observation.code fixed to "DIRECTLY OBSERVED DOSES TAKEN" at runtime Observation Type is used for searching and for organizing Common Observation records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. The element uses CWE to allow for the capture of Observation 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. EPHS: new vocab concepts needed. See implementation notes EPHS: vocab code needed for immunization interpretation EPHS: vocab domain needed for medical history EPHS: vocab domain needed for Assessment EPHS: vocab domain needed for encounter complication EPHS: concept code needed for Outbreak Complication Only 'nullFlavor' value of OTH is available. | 1 | Mand | negationInd :  Business name: D:Refuted Indicator When set to true, specifically flags the Common Observation record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. NOTE: This element should not be used to communicate negative findings, but rather circumstances where the observation itself was not actually made. E.g. "I did not make a diagnosis of meningitis" would be appropriate. "I diagnosed that they did not have meningitis" would not. (The latter would be handled as part of the code describing the diagnosis.) | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.DATETIME>  Business name: E:Observation Period Identifies the time at which the observation applies. Usually, this will be conveyed as a single point in time (center with a width of 0). However, some observations may cover a time-period with in which case start and end or start and duration may be specified. Note that the date the observation applies is not always the same as the time the observation is actually made. A lab example: if blood was drawn two days ago and White Blood Count (WBC) was done today, then WBC observation date should reflect the date of two days ago because that is the time the observation actually applies to. EPHS: signs and symptoms onset date maps to beginning of time interval, recovery date to end of interval Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 1 | Pop | confidentialityCode : SET<CV> (Confidentiality)  Business name: D:Observation Masking Indicators Communicates the desire of the patient to restrict access to this Common Observation 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | value : ANY  Business name: L:Observation Value Indicates what was actually observed when the observation was made. E.g. height in centimeters, weight in kilograms, code for pregnancy, code for blood type, etc. Conveys the clinical information resulting from the observation in a standardized representation. | 0-1 | Req | interpretationCode : SET<CE> (ObservationInterpretation)  Business name: M:Observation Normality Interpretation Identifies the level of variation of the observed state from what would be considered normal for a patient of similar age and gender. E.g. "Normal", "High", "Critically High", etc. Provides an ability to quickly flag observations that are outside the norm. These are generally the records which are of most interest from a clinical perspective. | 0-* | Req | | indirectTarget : IndirectTarget | 0-1 | Req | | responsibleParty : ResponsibleParty | 1 | Mand | | performer : Performer | 0-5 | Req | | author : Author3 | 1 | Mand | | informant : Informant | 0-1 | Req | | custodian1 : Custodian | 1 | Mand | | custodian2 : Custodian2 | 1 | Mand | | location : Location | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf | 0-1 | Req | | definition : Definition | 0-5 | Opt | | predecessor : Predecessor | 0-10 | Req | | reason : Reason | 0-5 | Req | | component : Component | 0-1000 | Req | | successor : Predecessor2 | 0-1 | Req | | subjectOf1 : Subject | 0-100 | Req | | subjectOf2 : Subject2 | 0-1 | Req | | componentOf1 : Component3 | 0-100 | Req | | componentOf2 : Component2 | 1-5 | Mand |
|
| |
| |
| |
| REPC_DM400000CA.IndirectTarget  Business name: *m:describes incident at Indicates the actual location where the incident described by the observation took place. E.g. site of accident, location of patient at time of cardiac arrest, location when subjected to exposure to a virus. This element will only be captured when it is of clinical interest or when typically captured as part of standard processes (e.g. EMS) The location of the actual 'event' captured by an observation may differ from the place where the observation was actually made. The location of the incident may provide context to a patient's condition. The information may also be of interest from a public health perspective. |
|---|
typeCode : "IND" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| |
| |
| |
REPC_DM400000CA.ResponsibleParty  Business name: b:supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Common Observation. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| REPC_DM400000CA.SubObservationEvent  Business name: Component Observations Captures components of a more complex observation, such as apgar or blood pressure. Not all observations can be expressed as a single code or code and value. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (NonLabDIObservationSubType)  Business name: Q: Component Observation Type Identifies the type of sub-observation being made. E.g. systolic blood pressure, APGAR skin color score, etc. EPHS: need fixed value for "COMPLICATIONS" EPHS:need fixed value for IMMUNIZATION VACCINE; VALID IMMUNIZATION DOSES RECEIVED;IMMUNIZATION DOSES NEEDED;ADDITIONAL COMPLICATION;CAUSE OF DEATH;OTHER COMPLICATION; RISK FACTOR CATEGORY;RISK FACTOR FREQUENCY; RISK FACTOR COMMENT; EPHS: need fixed value for OUTBREAK COMPLICATION AGGREGATE COUNT; OUTBREAK SIGN AND SYMPTOM UNIDENTIFIED AGGREGATE COUNT Distinguishes between multiple types of sub-observations that together make a single Observation. Code is mandatory to ensure that sub-observations are distinguishable. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. The element uses CWE to allow for the capture of Component Observation 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 | statusCode : "completed" (ActStatus) | 1 | Mand | value : ANY  Business name: R: Component Observation Value Indicates what was actually observed when the sub-observation was made. E.g. 120 mmHg for systolic blood pressure, 2 for APGAR skin color score, etc. EPHS: datatype needs to be constrained at runtime to CV, PQ or ST depending upon type of observation being reported. EPHS: vocab domains needed for CAUSE OF DEATH;VACCINE Conveys the clinical information resulting from the sub-observation in a standardized representation. There's no point sending a sub-observation if no value is known. Therefore, the attribute is mandatory. PHS 07-feb-02. Some appropriate vocab concept is needed for observation.code, to pair with EPHS mappings. | 1 | Mand |
|
| |
| REPC_DM400000CA.WorkingListEvent |
|---|
classCode : "LIST" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActNonLabDIObservationCategoryList)  Business name: J:Observation Categories Describes the categorization of the observation. E.g. markers of disease progression, co-morbidities / complications etc. Allows categorizing of observations for presentation. A given person may have had numerous observations related to a particular area. By associating categories, a person viewing the EHR information can first look at a list of categories and then drill down to the specific observation. The presence of this field is essential to prevent users from being overwhelmed, however not all observations will necessarily be categorizable. Therefore this element is marked as 'populated'. | 1 | Pop |
|
|
|
|
|---|
| REPC_DM500000CA.ActEvent |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood)  Need a harmonization approval to make ActMoodCompletionTrack specializable | 1 | Mand | id : II.BUS  Business name: K:Contained Service Event Ids References health service event records to be added to or removed from the care composition. One of the primary purposes of a care composition is to 'group' information. This attribute is the representation of that grouping. | 1 | Mand |
| REPC_DM500000CA.ActRequest  Business name: Request A particular request (referral or specific request) that resulted in the creation of the Care Composition. There are several pieces of information about a request that may influence understanding of the record including when requested, by whom, why, etc. Must have at least one of Request Id and Requesting Provider Request Type is mandatory when Request Id is present |
|---|
classCode : (x_ActClassCareProvisionEncounter)  Business name: Request Type This distinguishes between "referral" requests and specific orders. In the near term, the only way to request delivery of care is via a referral (PCPR). However, in the future, specific encounter sheduling messages may be defined. References to those new types of records would use ENC. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Care Composition Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: Request Id This identifies the specific request record (referral or order) that this Care Composition is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author2 | 0-1 | Req |
|
| REPC_DM500000CA.Author  Business name: *amended by This identifies the provider who most recently amended the Care Composition. The most recent Amending Provider has significant responsibility for the "current appearance" of the record and can have considerable influence on how other providers will interpret the validity and significance of the record. The element is mandatory because it should always be known by the EHR. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: G:Amend Datetime This indicates the last time a change was made to the Care Composition. It can be used by PoS applications to sort or filter records. Also provides information on how recently the record has changed. Because the element should always be known by the EHR, it is mandatory. | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
| REPC_DM500000CA.Author3  Business name: *a:authored by This identifies the provider who is responsible for the decision to capture the Care Composition in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Authored Datetime Indicates the time the decision to record when the Care Composition was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
| |
| REPC_DM500000CA.ControlActEvent  Business name: Amendment Summary Identifies information about the most recent change to the Care Composition including when it was made, by whom and why. Provides context information about the record. |
|---|
classCode : "CACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | reasonCode : (ControlActReason)  Business name: Amend Reason This indicates the reason for most recent amendment to the record as indicated by the person who made the change. Understanding the reason for the most recent amendment provides context for the current state of the record. The element uses CWE to allow for the capture of Amend Reason 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. | 0-1 | Req | | author : Author | 1 | Mand |
|
| REPC_DM500000CA.Custodian2  Business name: *g:associated with This indicates the physical facility where the Care Composition record is stored. This is generally the same as the location where the action was performed, but in some cases may be different. (E.g. where the action was done at the patient's home, but the data is captured and stored in the clinician's clinic. Used to indicate where records are likely kept for follow-up. This must always be known and is therefore mandatory. It may also be useful in understanding the context in which the event occurred. We need a new typeCode to distinguish the semantic of "owning location" from "occurence location" |
|---|
typeCode : "CST" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Mand |
|
REPC_DM500000CA.DiagnosisEvent  Business name: Discharge Diagnosis Describes the health conditions which were identified or determined as part of the encounter. These are key elements in defining the encounter. |
|---|
classCode : "OBS" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (ActCode)  Business name: A:Diagnosis Type Identifies the type of diagnosis Identifies this observation as a type of diagnosis and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | value : (DiagnosisValue)  Business name: Diagnosis Code A coded form of the condition that was identified as part of the care delivery described by this Care Composition. Allows tracking outcomes and provides key information about the encounter This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
| REPC_DM500000CA.Discharger  Business name: p:discharged by Indicates the provider who made the decision to end the encounter. Provides a point of contact for follow-up. The discharging provider generally has the best sense of the complete set of care associated with the encounter because they have generally reviewed the complete set of records in constructing a discharge or care summary. They also generally take the responsibility for ensuring the safe transition of the patient back into the community environment or whatever other care setting the patient transitions to. May only be used when Care Composition Type is Encounter or a specialization of Encounter |
|---|
typeCode : "DIS" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
| REPC_DM500000CA.EntityQuantifiedKind |
|---|
classCode : "ENT" (EntityClass) | 1 | Mand | determinerCode : "QUANTIFIED_KIND" (EntityDeterminer) | 1 | Mand | quantity : INT.POS  Business name: J:Number of Patients Indicates the number of patients involved in a group encounter. For non-group encounters, this attribute will always be "1". Allows a provider to ascertain the size of a group encounter without necessarily revealing the identity of the patients involved. The patients associated with an encounter must be specified at the time the record is created, thus the number of patients will always be known, making this element mandatory. | 1 | Mand |
| |
| REPC_DM500000CA.Location  Business name: h:occurred at This identifies the location where the Care Composition actually occurred. E.g. Patient's residence, clinic, work site, etc. It only needs to be specified when the occurrence location differs from the official record location. In circumstances where number of locations involved is greater than the limit supported by the message, multiple encounters should be used. The site of the actual event provides context for interpreting the record. In some cases, it may also provide follow-up information Multiple repetitions are allowed for telehealth and other remote encounters. Must not be specified when Care Composition Type is 'Condition-based' |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| | REPC_DM500000CA.Material |
|---|
classCode : "MAT" (EntityClass) | 1 | Mand | determinerCode : "INSTANCE" (EntityDeterminer) | 1 | Mand | desc :  Business name: I: Focus Area Describes the specific body region or area associated with a Localized Health Condition-based Collection. E.g. "Left-most mole approximately one inch below left shoulder-blade" Allows grouping observations, procedures and other records directly associated with a particular mole, tumor or other potion of a patient not easily referencable as a coded body site. This element is optional because not all systems will support Localized Health Condition-based Collections | 1 | Mand |
|
| |
| REPC_DM500000CA.Participant  Business name: *has Identifies the participants associated with the particular location. Important for providing context for the encounter. The element is mandatory because there whole purpose of having a participant grouping is to have participants. Cardinality is constrained to 200 rather than 1000 because it is exactly equal to the sum of the number of potential patients and providers |
|---|
typeCode : "PART" (ParticipationType) | 1 | Mand | modeCode : (ParticipationMode)  Business name: B:Participation Mechanism Identifies how the patient and/or provider(s) participated in the encounter (in person, by phone, by videoconference, etc.) Understanding how each participant was involved in the encounter gives context to the encounter, particularly for telehealth. | 0-1 | Req | | role : Role | 1 | Mand |
|
| REPC_DM500000CA.PatientCareProvisionEvent  Business name: Care Composition 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. Care composition messages may be sent during the course of care to describe the progress of care or may be sent at the termination of care to describe all the activities that occurred during the provision of care. Note that this record merely captures the existence of care and the locations and people involved. The actual discrete events and any care summary documentation that results are captured using other messages. Examples include: encounters, condition-related care (episodes) and longer-term care collections such as "gynecological care". Care compositions allow grouping together numerous related records which aids searching and navigation. Also, the mere knowledge that a type of care has occurred or is occurring (e.g. an in-patient hospital encounter) can be useful information when deliverying subsequent care. Annotation is only permitted if Annotation Indicator is not present and vice versa Refuted Indicator cannot be specified unless Care Composition Type is Encounter or a specialization there-of. |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A: Care Composition Id A globally unique identifier assigned by the EHR to the Care Composition record. Allows for unique identification of the Care Composition and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 0-2 | Opt | code : (ActCareEventType)  Business name: B: Care Composition Type Identifies the type of Care Composition represented by this record. Care Composition is the generic name given to event 'containers' such as Encounters, Health-Condition-based Collections (Episodes) and Care-based Collections. The "type" of care composition places constraints on what elements are supported. Encounter-based collection: a series of health care events that occur during an interaction between one or more health care providers and one or more patients where the providers and the patient remain in the same location over a contiguous period of time; the providers and patient may be at different locations (telehealth). e.g. Inpatient encounter, Community encounter. Condition-based collection (Episode): a series of interactions between a patient and one or more health care providers over time in one or more locations and tied together by a common diagnosis or problem. Care-based collection: a high level grouping of health events, encounters, and/or episodes related to a particular area of healthcare. e.g. Gynecological care, Cardiological Care, etc. Care Composition Type is used for searching and for organizing Care Composition records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | negationInd :  Business name: D:Refuted Indicator When set to true, specifically flags the Care Composition record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. | 1 | Mand | statusCode : (ActStatus)  Business name: C: Care Composition Status This identifies the current state of the Care Composition record. Allowed status values are 'active' (the encounter, episode or general delivery of care ongoing) and 'completed' (the encounter, episode or general care has ended). Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Care Composition record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATETIME>  Business name: F: Care Composition Period Represents the start and end of the date/time interval during which the care described by the composition was/is being provided. E.g. The admission and discharge date/time; the date on which the episode began and ended; etc. Please note that it is possible for many episodes and care events to not have an end date; in these situations, only the start date will be specified. Even encounters will not have an end date until the encounter is completed/patient is discharged. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 1 | Pop | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: E: Care Composition Masking Indicators Communicates the desire of the patient to restrict access to this Care Composition 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') 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. Masking a care composition record masks it for all associated patients (i.e. all patients involved in the care composition as a group). Also, masking a care composition implicitly masks all records associated with that care composition. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | | subject1 : Subject6 | 0-1 | Opt | | subject2 : Subject7 | 1-100 | Mand | | subject3 : Subject5 | 0-1 | Opt | | responsibleParty : ResponsibleParty | 1 | Mand | | performer : Performer3 | 0-10 | Req | | author : Author3 | 1 | Mand | | informant : Informant | 0-1 | Req | | discharger : Discharger | 0-1 | Req | | custodian1 : Custodian | 1 | Mand | | custodian2 : Custodian2 | 1 | Mand | | location : Location | 0-100 | Req | | outcome : Outcome | 0-100 | Req | | inFulfillmentOf : InFulfillmentOf | 0-1 | Req | | predecessor : Predecessor | 0-10 | Req | | replacementOf : ReplacementOf | 0-1 | Req | | reason : Reason | 0-10 | Req | | component1 : Component3 | 0-1000 | Req | | component2 : Component2 | 0-100 | Opt | | successor : Predecessor2 | 0-1 | Req | | subjectOf1 : Subject2 | 0-100 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | subjectOf3 : Subject | 0-1 | Req | | subjectOf4 : Subject4 | 0-1 | Req | | componentOf : Component | 0-100 | Req |
|
REPC_DM500000CA.PatientCareProvisionEventPortion  Business name: Participant Groupings Identifies a 'portion' of the encounter performed at a single location. Allows tracking what participants were present at each location within the encounter. This information provides context for the events within the encounter. May only be used when Care Composition Type is Encounter or a specialization of Encounter All participant identifiers must correspond to either patient identifiers or performer identifiers |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | | location : Location2 | 1 | Mand | | participant : Participant | 1-200 | Mand |
| |
| |
REPC_DM500000CA.Reason  Business name: k:because of Identifies the clinical reason(s) for performing the action described by the record. For health condition-based (episode) collections, there must be exactly one indication (the 'definitional' problem for the episode). For care-based collections, there should not be any indications. (Problems are captured as part of the overall care, not as the reason for care.) Essential for understanding the context in which the action was performed. Also frequently used in searching and filtering and can impact whether the record will be automatically masked. Multiple indications are supported for circumstances where the Care Composition is being done for multiple reasons. Association is mandatory, 1..1 when Care Composition Type is Episode (Health Condition-based) or a specialization there-of |
|---|
typeCode : "RSON" (ActRelationshipType) | 1 | Mand | contextControlCode : "AN" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | | Choice: indications : Indications | 1 | Pop | | »» observationCondition : ObservationCondition | 0-1 | Opt | | »» otherIndication : OtherIndication | 0-1 | Opt |
| |
REPC_DM500000CA.ResponsibleParty  Business name: b:supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Care Composition. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| REPC_DM500000CA.Role  Business name: Participants Identifies a Provider or Patient involved in the encounter. Allows identifying what participants were in each location. |
|---|
classCode : "ROL" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: A: Participant Id Reference The unique identifier of a patient or provider who was involved in the encounter at the identified location. This will reference one of the patient or provider ids already associated with the Care Composition. Links the participant to the location where they were involved in the encounter. The element is mandatory because there's no point listing participants unless they can be explicitly identified. | 1 | Mand | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: C: Participant Confidentialities Identifies the confidentiality level associated with the encounter for this specific participant. This element should only be specified if the id is referencing a patient, not a provider. Stricter confidentiality asserted at the overall encounter level overrides looser confidentiality asserted at the participant level. Provides individual participants in a group encounter with complete control over the confidentiality of their participation in that encounter. The attribute is optional because not all systems will support masking. | 0-2 | Opt |
|
| REPC_DM500000CA.ServiceDeliveryLocation |
|---|
classCode : "SDLOC" (RoleClass) | 1 | Mand | id : II.PUBLIC  Business name: Location Id Reference References the location for which the participants are being identified. This will be a location already associated with the care composition. Allows linking participants to locations. | 1 | Mand |
| |
| |
| |
| REPC_DM500000CA.Subject6  Business name: y:pertains to Indicates the specimen involved in the care event. Allows for individual specimen (such as moles) to be tracked in a composition. This association is optional because not all systems will support this type of care composition. Focus Area is only permitted when Care Composition Type is "Localized Health Condition-based Collection" |
|---|
typeCode : "SBJ" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | specimen : Specimen | 1 | Pop |
|
|
|
|
|
|---|
| REPC_DM600000CA.ActDefinition |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "DEF" (ActMood) | 1 | Mand | id : II.BUS  Business name: G:Protocol Ids Indicates that the action described by the Professional Service record was performed as part of a particular protocol. Allows linking together a series of observations, procedures, drug administrations and other clinical actions as part of a particular protocol. Useful in clinical studies and may also provide context around why the action was performed. The element also allows providers to filter searches to only expose data related to a particular protocol. This element is optional because the use of and need to reference protocols will not apply to all healthcare providers. PoS applications should choose whether to support the element based on the perceived needs of their client base. | 1 | Mand |
| REPC_DM600000CA.ActRequest  Business name: A:Request This ties the record to the request (referral or specific request) that resulted in the creation of the Professional Service record. By requesting the action, a provider takes a level of responsibility for it. Also, a link between request and fulfilling record may result in differences in query responses. For example retrieving a request may also result in retrieval of fulfilling records. Requesting providers generally have authorization to view masked information as well. |
|---|
classCode : (x_ActClassCareProvisionProcedure)  Business name: B:Request Type This distinguishes between "referral" requests and specific orders. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Professional Service Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: A: Request Id This identifies the specific request record (referral or order) that this Professional Service is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author | 0-1 | Req |
|
| REPC_DM600000CA.Author  Business name: *c:requested by This identifies the provider who requested the Professional Service to be performed. The request may have been verbal, electronic, as part of a referral or by other means. This element does not need to be captured in "record" and "amend" messages where a request id is captured, as the requesting provider can be looked up by retrieving the request. By requesting the action, the provider takes a level of responsibility for it. The attribute may also be used to search or filter records. Requesting providers generally have authorization to view masked information as well. ZPS.6 A_BillableClinicalService |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Pop | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
REPC_DM600000CA.Author3  Business name: *a:authored by This identifies the provider who is responsible for the decision to capture the Professional Service in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: A: Authored Datetime Indicates the time the decision to record when the Professional Service was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| | REPC_DM600000CA.ClinicalDocumentEvent |
|---|
classCode : (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: K:Service Report Reference Id An identifier for a report associated with the procedure. Allows for a direct link to a report that has been written on the procedure. Often surgical, and even psychological procedures can result in numerous observations, and other information generally captured in narrative form. When filled in, this attribute allows the user to drill down to the Clinical Observation Document record used to capture this additional information. | 1 | Mand |
|
| |
| |
| |
| |
| |
| |
| REPC_DM600000CA.ProcedureEvent  Business name: Professional Service This is the information that is recorded and maintained on a consultative, surgical or physical service (procedure) provided to the patient. Counseling, education, surgeries and physical therapy are examples of the types of services that can be captured. Information about surgeries, councilling and other professional services is a key element of the EHR. It provides context around services provided and may inform choices about how best to manage the patient's healthcare. A_BillableClinicalService Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
classCode : "PROC" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A:Service Record Id A globally unique identifier assigned by the EHR to the Professional Service record. Allows for unique identification of the Professional Service and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). PatientConsultation.patientConsultationkey PatientConsultation.externalId ZRV.5 ZPS.2 ZPS.3 Claim.455-EM (root) Claim.402-D2 (extension) A_BillableClinicalService | 0-2 | Opt | code : CD (ActProfessionalServiceCode)  Business name: B:Service Type Identifies the type of Professional Service represented by this record. e.g. appendectomy, smoking cessation counseling, physiotherapy Service Type is used for searching and for organizing Professional Service records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. The element uses CWE to allow for the capture of Service 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. PatientConsultation.category D57 ZPS.5.1 ZPS.5.2 (experience handled as qualifier) Claim.436-E1 (code system) Claim.407-D7 (mnemonic) Claim.459-ER (modifier) Claim.418-DI (modifier) DUR/PPS.474-8E (modifier) A_BillableClinicalService | 1 | Mand | negationInd :  Business name: C:Refuted Indicator When set to true, specifically flags the Professional Service record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. | 1 | Mand | statusCode : "completed" (ActStatus) | 1 | Mand | effectiveTime : IVL<TS.FULLDATE>  Business name: E:Service Time and Length The date and time during which the professional service was performed, as well as the duration of the service. May be specified as any one or two of start time, end time and duration. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. PatientConsultation.eventTime(Low) patientConsultation.eventDuration(Width) ZPS.4 (center) ZPS.5.2(timing portion of code set) Claim.457-EP A_BillableClinicalService Center date cannot be null but duration can be left unspecified if not known. | 1 | Pop | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: D:Service Masking Indicators Communicates the desire of the patient to restrict access to this Professional Service 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | | responsibleParty : ResponsibleParty2 | 1 | Mand | | performer : Performer | 0-5 | Req | | author : Author3 | 1 | Mand | | informant : Informant | 0-1 | Req | | custodian1 : Custodian | 1 | Mand | | custodian2 : Custodian2 | 1 | Mand | | location : Location | 0-1 | Req | | inFulfillmentOf : InFulfillmentOf | 0-1 | Req | | definition : Definition | 0-5 | Opt | | predecessor : Predecessor | 0-10 | Req | | reason : Reason | 0-5 | Req | | successor : Predecessor2 | 0-1 | Req | | subjectOf1 : Subject2 | 0-100 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | subjectOf3 : Subject4 | 0-1 | Req | | componentOf1 : Component | 1-5 | Pop | | componentOf2 : Component2 | 0-100 | Req |
|
| REPC_DM600000CA.ResponsibleParty2  Business name: b:supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Professional Service. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
| |
| | REPC_DM600000CA.WorkingListEvent |
|---|
classCode : "LIST" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActProcedureCategoryList)  Business name: K:Service Categories Describes the categorization of the service. E.g. Psychological Counseling, Smoking Cessation, Cardiac Surgeries, etc. Categories are inferred from the terminology hierarchy and thus aren't specified as part of the 'record' message. Allows categorizing professional services for presentation. A given person may have had numerous procedures related to a particular area. By associating categories with procedures, a person viewing the EHR information can first look at a list of categories and then drill down to the specific procedures. The presence of this field is essential to prevent users from being overwhelmed, however not all services will necessarily be categorizable. Therefore this element is marked as 'populated'. | 1 | Pop |
|
|
|
|
|---|
| REPC_DM900000CA.Address |
|---|
value : AD.SEARCH  Business name: ZE: Address If specified, filters the returned location records to those in the specified province/territory or municipality. Allows filtering the physical location of the facility. | 1 | Mand |
| | REPC_DM900000CA.AmendedSinceDateTime |
|---|
value : TS.FULLDATETIME  Business name: K: Updated Since DateTime Filters the records retrieved to only include those which have been created or revised since the specified date and time. If unspecified, no filter is applied. Useful to retrieve information "since you last checked". | 1 | Mand |
|
| REPC_DM900000CA.AttestedIndicator |
|---|
value :  Business name: ZM: Attested Indicator If specified, filters the returned documents to only include those which have been attested as correct by the document author or which have not been authenticated. If not specified, both attested and non-attested documents will be returned. Relevant for transcribed reports (e.g. the data enterer is different than the 'author'). Records where "attestation" is marked as "Not applicable" will be treated as attested. Allows filtering to only see those documents which are "known" to be accurate. May also be used to retrieve documents associated with a provider which are unauthenticated. | 1 | Mand |
| | REPC_DM900000CA.CareCompositionId |
|---|
value : II.BUS  Business name: R: Care Composition Ids Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied. Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral. Allows retrieving all records associated with an encounter, episode or care event. | 1 | Mand |
|
| REPC_DM900000CA.CareCompositionType |
|---|
value : (ActCareEventType)  Business name: S: Care Composition Types Filters the records retrieved to only include those associated with the specified 'kind' of encounter, episode or care event. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular type of encounter, episode or care event. E.g.Orthopedic Clinic Encounter, ER encounter, Walk-in encounter, etc. | 1 | Mand |
| | REPC_DM900000CA.DiscreteRecordTypes |
|---|
value : (ActEventCategoryWorkingListCode)  Business name: X: Discrete Record Types Identifies which types of records (allergies, drugs, lab results, referrals, etc.) should be returned in discrete form. It is possible for a given type of information to be returned in both discrete and document form. If not specified, default is all data will be returned discretely. To retrieve no discrete data, use a null flavor of "NA". Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows filtering of the clinical summary to only include types of information required by the application and/or which it is capable of supporting. | 1 | Mand |
|
| REPC_DM900000CA.DocumentRecordTypes |
|---|
value : (ActEventCategoryWorkingListCode)  Business name: Y: Document Record Types Identifies which types of records (allergies, drugs, lab results, referrals, etc.) should be returned in rendered document form. It is possible for a given type of information to be returned in both discrete and document form. If not specified, default is all data will be returned in document form. To retrieve no rendered data, use a null flavor of "NA" Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows returning discrete data rendered into document form for applications not capable of displaying data retrieved in discrete form. | 1 | Mand |
| | REPC_DM900000CA.EHRRepositoryId |
|---|
value : II.BUS  Business name: Q: EHR Repository Id Filters the records retrieved to only include those records from a specific EHR repository. If unspecified, all "connected" EHR repositories will be searched. Primarily intended to allow filtering an initial search to a local EHR repository for performance reasons. | 1 | Mand |
|
| REPC_DM900000CA.EffectiveTimeRange |
|---|
value : IVL<TS.FULLDATETIME>  Business name: J: Effective Time Range Filters the set of records to be retrieved to those which occurred or were effective for the patient within the time boundaries specified. Either the lower bound or upper bound or both would be specified. If no value is specified, no filter will be applied. If there is any overlap between the specified time-range and the effective time of the record, the record will be returned. Allows constraining the retrieved records to those applicable at a particular time. Useful in retrieving those records "currently in effect" as well as retrieving views of what information was in effect at some point in the past. | 1 | Mand |
| | REPC_DM900000CA.EventCategory |
|---|
value : (ActListCode)  Business name: ZJ: Event Categories If specified, filters the returned records to those having the specified category. E.g. "Allergy/Intolerance", "Measured Observation", "Cognitive Procedure". (Contrast this with "Type" which would allow searching for "Drug Allergies", "Patient Weight" and "Smoking Cessation Counseling".) Allows filtering responses based on higher level categorization. Multiple repetitions are supported to allow for multiple categories to be returned. | 1 | Mand |
|
| REPC_DM900000CA.EventLocationId |
|---|
value : II.PUBLIC  Business name: O: Event Location Id Filters the records retrieved to only include those records which are officially associated with and/or were performed by a particular facility. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location id. Records associated with "sub-locations" (e.g. departments, wards) will be returned when searching by the larger location (e.g. hospital). Allows retrieving those records associated with a particular facility. | 1 | Mand |
| | REPC_DM900000CA.EventLocationType |
|---|
value : (ServiceDeliveryLocationRoleType)  Business name: P: Event Location Type Filters the records retrieved to only include those records which are officially associated with and/or were performed by facilities with the specified type. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location type. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records associated with a particular kind of facility. E.g. Hospital, clinic, pharmacy, patient residence, etc. | 1 | Mand |
|
| REPC_DM900000CA.FilterTemplateId |
|---|
value : II.BUS  Business name: W: Filter Template Id Indicates that the returned results are to be filtered acording to the specified template. If not specified, no filter is applied. The specific types of templates available are undefined and may vary by jurisdiction. Allows the application of complex filtering rules such as "All information relevant to diabetes management" or "cardiologist view of patient record". The query allows distinct filters to be applied to different types of records. E.g. all allergies, only most recent lab tests of a particular type, drugs of one of 5 types, etc. In some cases, the template may influence how document views of different information types are rendered. | 1 | Mand |
| | REPC_DM900000CA.HealthCondition |
|---|
value : CD (ActHealthConditionType)  Business name: T: Health Conditions Filters the records retrieved to only include those associated with the specified health condition (e.g. has indication, discharge diagnosis, condition type, etc. Specifically, any record having an "indication" which matches the specified code, any Care composition or Discharge-Care Summary with a discharge disposition which matches the specified code, or any Coded Observation which matches the specified code and any Health Condition which matches the specified code). If there are episodes associated with the condition, the query will also return records associated with that episode. (I.e. Any record tied to an episode with an associated health condition has an implicit relationship to that health condition.) If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular health condition or problem. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| REPC_DM900000CA.IncludeHistoryIndicator |
|---|
value :  Business name: G: Include History Indicator If true, indicates that historical versions of the record(s) should be included. If false, only the current version will be returned. Allows a user to filter whether historical information is needed. Retrieving historical information will be needed in some circumstances, but it makes sense to constrain. The attribute is mandatory because it must be known whether history is to be returned or not. | 1 | Mand |
| | REPC_DM900000CA.IncludeNotesIndicator |
|---|
value :  Business name: F: Include Notes Indicator If true, indicates that notes should be included when retrieving the record(s). If false, notes will not be returned. Allows filtering whether supplemental comments should be retrieved or not. Some uses of the record do not require having the supplemental information available. The attribute is mandatory because it must be known whether notes are to be returned or not. | 1 | Mand |
|
| REPC_DM900000CA.Indication |
|---|
value : CD (ActIndicationType)  Business name: U: Indication Filters the records retrieved to only include those where the "indication" (reason) for the record was the specified code. This is distinct from the Health Condition query parameter in that it will only return records with an explicit indication match (it will not match on discharge diagnosis, part of related episode, etc.) It also allows searching on indications such as prophylaxis, surgery prep, etc. Allows retrieving all records associated with a particular indication. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
| | REPC_DM900000CA.LocationMobileIndicator |
|---|
value :  Business name: ZC: Location Mobile Indicator If specified, filters the returned location records to either those which are mobile or non-mobile. If unspecified, no filter is applied. Allows restricting to either mobile or non-mobile locations. | 1 | Mand |
|
| REPC_DM900000CA.LocationPlaceType |
|---|
value : (ServiceDeliveryLocationPlaceType)  Business name: ZA: Location Place Type Filters the returned location records to only include specific types of places such as facilities, departments, buildings, wards, etc. Allows constraining the types of records to retrieve. Multiple repetitions are provided to allow more than one type to be included. | 1 | Mand |
| | REPC_DM900000CA.LocationServiceType |
|---|
value : (ActServiceDeliveryLocationService)  Business name: ZB: Location Service Types Filters the returned location records to only include locations that provide the specified type of service(s), etc. Multiple repetitions will be treated as "AND". I.e. Locations that provide A and B. If this criterion is used, it will only match on services that are marked as "available". Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows searching for facilities able to deliver certain services or groups of services. | 1 | Mand |
|
| REPC_DM900000CA.MostRecentByTypeIndicator |
|---|
value :  Business name: V: Most Recent By Type Indicator If true, indicates that only the most recent records of a given type or category should be retrieved. I.e. If there are 10 records of the same kind, only the most recent one would be returned. If false, all occurrences will be returned. Provides a mechanism of getting a quick overview of the types of events that have occurred without needing to look at all occurrences. The attribute is mandatory because it must be known whether to return the most recent or all records. | 1 | Mand |
| | REPC_DM900000CA.NameContains |
|---|
value :  Business name: Z: Name Contains Filters the returned location records to only include those whose name includes the specified string. If unspecified, no filter is applied. Allows searching by name. Note: Searches should be case-insensitive and should ignore punctuation and spacing. Some implementations may perform "sounds-like" searches. | 1 | Mand |
|
| REPC_DM900000CA.NearAddress |
|---|
value : AD.BASIC  Business name: ZF: Near Address Identifies an address that returned locations should be near to. Results will be filtered to those appearing within the specified radius from the identified address. Allows retrieving facilities near to a particular location. | 1 | Mand |
| |
| REPC_DM900000CA.ProtocolId |
|---|
value : II.BUS  Business name: ZI: Protocol Ids Filters the records retrieved to only include those associated with the specified protocols. If unspecified, no filter is applied. Allows retrieving records associated with a particular protocol. Useful in clinical studies and other research. The element is optional because support for protocols is not deemed a neccesity for many healthcare providers. | 1 | Mand |
| | REPC_DM900000CA.RecipientLocationId |
|---|
value : II.PUBLIC  Business name: ZO: Recipient Location Id If specified, filters the returned documents to only include those which were targeted to the specified location. If not specified, no filter is applied Allows retrieval of all documents sent to a particular location. E.g. "Find all documents targeted to my location" | 1 | Mand |
|
| REPC_DM900000CA.RecipientProviderId |
|---|
value : II.PUBLIC  Business name: ZN: Recipient Provider Id If specified, filters the returned documents to only include those which were targeted to the specified provider. If not specified, no filter is applied Allows retrieval of all documents sent to a particular provider. E.g. "Find all documents targeted to me" | 1 | Mand |
| | REPC_DM900000CA.RecordId |
|---|
value : II.BUS  Business name: E: Record Ids A globally unique identifier assigned by the EHR to the record (or records) to be retrieved. Specifically identifies the record to be returned. Because the primary purpose of the query is to retrieve identified records, the element is mandatory. Multiple repetitions are allowed to support multiple detail records as part of one query for efficiency reasons. | 1 | Mand |
|
| REPC_DM900000CA.RecordStatus |
|---|
value : (ActStatus)  Business name: I: Record Statuses Filters the set of records to be retrieved to only include those with the identified status(s). If no values are specified, no filter will be applied. Allows constraining the status of records to be retrieved. Multiple repetitions are present to allow selection of multiple statuses with a single query. | 1 | Mand |
| | REPC_DM900000CA.RecordType |
|---|
value : CD (ActCode)  Business name: H:Record Types Filters the type(s) or category(ies) of the records to be retrieved. The query will return both those records whose type exactly matches, as well as those whose types are subsets of the specified parameter. If no Types are specified, no restriction will be placed on the types to be returned. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows constraining the type of records to be retrieved. Multiple repetitions are present to allow selection of multiple types with a single query. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| REPC_DM900000CA.RegionId |
|---|
value : II.PUBLIC  Business name: ZD: Region Ids If specified, filters the returned location records to those which are part of the specified 'region'. Allows restricting the retrieved locations to those associated with a particular health region. | 1 | Mand |
| | REPC_DM900000CA.RequestId |
|---|
value : II.BUS  Business name: ZL: Request Id If specified, filters the returned records to only include those which are in fulfillment of the specified request record. If unspecified, no filter is applied. Allows retrieving records in fulfillment of a particular request. | 1 | Mand |
|
| REPC_DM900000CA.RequestingProviderId |
|---|
value : II.BUS  Business name: N: Requesting Provider Id Filters the records retrieved to only include those whose creation/performance were requested by the identified provider. If unspecified, no filter is applied. Allows a provider to see the results of any requests they may have made. | 1 | Mand |
| | REPC_DM900000CA.ResponsibleOrganizationId |
|---|
value : II.PUBLIC  Business name: ZH: Responsible Organization Id If specified, filters the returned location records to those which are under the responsibility of the specified organization. Allows returning all locations associated with a particular organization. | 1 | Mand |
|
| REPC_DM900000CA.ResponsibleProviderId |
|---|
value : II.PUBLIC  Business name: L: Responsible Provider Id Filters the records retrieved to only include those where the identified provider was the author, supervisor or performer. If unspecified, no filter is applied. Allows retrieving those records in which a particular provider has a vested interest. | 1 | Mand |
| | REPC_DM900000CA.ResponsibleProviderType |
|---|
value : (HealthcareProviderRoleType)  Business name: M: Responsible Provider Type Filters the records retrieved to only include those where the author, supervisor or performer was of the specified provider type. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records in which a particular kind of provider has a vested interest. | 1 | Mand |
|
| REPC_DM900000CA.SearchRadius |
|---|
value : PQ.DISTANCE  Business name: ZG: Search Radius Identifies the distance from the "Near Address" within which locations should be retrieved. Allows retrieving facilities near to a particular location. | 1 | Mand |
|
|
|
|
|---|
| REPC_MT000003CA.ConditionEvent  Business name: Health Condition A record of a patient's health condition, as tracked over time. Examples include diseases, disabilities, pregnancy, lactation and other clinical conditions of interest. Also known as "Problem" (from a 'problem list'). Necessary component of a person's overall profile. Helps with contraindication checking. Code is fixed DX if not using SNOMED; Code is fixed to 'Assertion' if using SNOMED |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ActCode)  Business name: B: Condition Type Designates the concept in DiagnosisValue as a Diagnosis Condition Type is used for searching and for organizing Health Condition records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. Since all diagnosis concepts can be represented in a single field, this domain is a fixed value | 1 | Mand | negationInd :  Business name: E: Refuted Indicator When set to true, specifically flags the Health Condition record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. | 1 | Mand | statusCode : (ActStatus)  Business name: C:Condition Status This identifies the current state of the Health Condition record. Indicates whether the condition is still being monitored as relevant to the patient's health ('active') or whether the condition is no longer considered a relevant 'problem' ('completed'). It may also be 'obsolete' in circumstances where the record has been replaced. Note that a problem may be considered 'active' even if the underlying condition is no longer affecting the patient. For example, for a patient who was recently pregnant, the pregnancy has ended, but the pregnancy would still be an 'active' condition record because of it's ongoing impact on the patient's healthcare situation. To convey the actual clinical status of the condition, use SNOMED post-coordination in the Condition attribute. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Health Condition record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATE>  Business name: G: Condition Time Period The date on which the condition first began and when it ended. For ongoing conditions such as chronic diseases, the upper boundary may be unknown. For transient conditions such as pregnancy, lactation, etc; the upper boundary of the period would usually be specified to signify the end of the condition. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 0-1 | Req | confidentialityCode : SET<CV> (x_NormalRestrictedTabooConfidentialityKind)  Business name: F: Condition Masking Indicators 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | value : CD (DiagnosisValue)  Business name: K:Condition A code indicating the specific condition. E.g. Hypertension, Pregnancy. This is the central piece of information in recording a condition, therefore the attribute is mandatory. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Condition 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 | | informant : Informant | 0-1 | Req | | predecessor : Predecessor | 0-10 | Req | | subjectOf : Subject3 | 0-1 | Req | | componentOf : Component | 0-100 | Req |
|
| |
| |
|
|
|
|---|
| REPC_MT000007CA.Author  Business name: *a:authored by This identifies the provider who is responsible for the decision to capture the Health Condition in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. AllergyIntolerance.authorizingProvider ZPB1.3 AllergyIntolerance.authorizingPhysician |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Authored Datetime Indicates the time the decision to record when the Health Condition was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
REPC_MT000007CA.Author3  Business name: *last amended by This identifies the provider who most recently amended the Health Condition. The most recent Amending Provider has significant responsibility for the "current appearance" of the record and can have considerable influence on how other providers will interpret the validity and significance of the record. The element is mandatory because it should always be known by the EHR. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Amend Datetime This indicates the last time a change was made to the Health Condition. It can be used by PoS applications to sort or filter records. Also provides information on how recently the record has changed. Because the element should always be known by the EHR, it is mandatory. | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
REPC_MT000007CA.ConditionEvent  Business name: Health Condition A record of a patient's health condition, as tracked over time. Examples include diseases, disabilities, pregnancy, lactation and other clinical conditions of interest. Also known as "Problem" (from a 'problem list'). Necessary component of a person's overall profile. Helps with contraindication checking. Code is fixed DX if not using SNOMED; Code is fixed to 'Assertion' if using SNOMED |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Condition Identifier A globally unique identifier assigned by the EHR to the Health Condition record. The identifier applies to this "instance" of the condition. For example, multiple pregnancies would each be treated as distinct conditions, each with a unique id. Allows for unique identification of the Health Condition and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 1 | Mand | code : (ActCode)  Business name: B: Condition Type Designates the concept in DiagnosisValue as a Diagnosis Condition Type is used for searching and for organizing Health Condition records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. Since all diagnosis concepts can be represented in a single field, this domain is a fixed value | 1 | Mand | negationInd :  Business name: E: Refuted Indicator When set to true, specifically flags the Health Condition record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. | 1 | Mand | statusCode : (ActStatus)  Business name: C:Condition Status This identifies the current state of the Health Condition record. Indicates whether the condition is still being monitored as relevant to the patient's health ('active') or whether the condition is no longer considered a relevant 'problem' ('completed'). It may also be 'obsolete' in circumstances where the record has been replaced. Note that a problem may be considered 'active' even if the underlying condition is no longer affecting the patient. For example, for a patient who was recently pregnant, the pregnancy has ended, but the pregnancy would still be an 'active' condition record because of it's ongoing impact on the patient's healthcare situation. To convey the actual clinical status of the condition, use SNOMED post-coordination in the Condition attribute. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Health Condition record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATE>  Business name: G: Condition Time Period The date on which the condition first began and when it ended. For ongoing conditions such as chronic diseases, the upper boundary may be unknown. For transient conditions such as pregnancy, lactation, etc; the upper boundary of the period would usually be specified to signify the end of the condition. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 0-1 | Req | confidentialityCode : SET<CV> (x_NormalRestrictedTabooConfidentialityKind)  Business name: F: Condition Masking Indicators 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Req | value : CD (DiagnosisValue)  Business name: K:Condition A code indicating the specific condition. E.g. Hypertension, Pregnancy. This is the central piece of information in recording a condition, therefore the attribute is mandatory. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Condition 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 | | responsibleParty : ResponsibleParty | 1 | Mand | | author : Author | 1 | Mand | | informant : Informant | 0-1 | Req | | custodian1 : Custodian2 | 1 | Mand | | custodian2 : Custodian | 1 | Mand | | predecessor : Predecessor | 0-10 | Req | | successor : Predecessor2 | 0-1 | Req | | subjectOf1 : Subject | 0-1 | Req | | subjectOf2 : Subject6 | 0-1 | Req | | componentOf : Component | 0-100 | Req |
| REPC_MT000007CA.ControlActEvent  Business name: Amendment Summary Identifies information about the most recent change to the Health Condition including when it was made, by whom and why. Provides context information about the record. |
|---|
classCode : "CACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | reasonCode : (ControlActReason)  Business name: B:Amend Reason This indicates the reason for most recent amendment to the record as indicated by the person who made the change. Understanding the reason for the most recent amendment provides context for the current state of the record. The element uses CWE to allow for the capture of Amend Reason 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. | 0-1 | Req | | author : Author3 | 1 | Mand |
|
| |
| |
| |
| REPC_MT000007CA.ResponsibleParty  Business name: c:supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Health Condition. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
| |
|
|
|
|---|
| REPC_MT000008CA.AmendedSinceDateTime |
|---|
value : TS.FULLDATETIME  Business name: K: Updated Since DateTime Filters the records retrieved to only include those which have been created or revised since the specified date and time. If unspecified, no filter is applied. Useful to retrieve information "since you last checked". | 1 | Mand |
| | REPC_MT000008CA.CareCompositionId |
|---|
value : II.BUS  Business name: R: Care Composition Ids Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied. Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral. Allows retrieving all records associated with an encounter, episode or care event. | 1 | Mand |
|
| REPC_MT000008CA.CareCompositionType |
|---|
value : (ActCareEventType)  Business name: S: Care Composition Types Filters the records retrieved to only include those associated with the specified 'kind' of encounter, episode or care event. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular type of encounter, episode or care event. E.g.Orthopedic Clinic Encounter, ER encounter, Walk-in encounter, etc. | 1 | Mand |
| | REPC_MT000008CA.DiscreteRecordTypes |
|---|
value : (ActEventCategoryWorkingListCode)  Business name: X: Discrete Record Types Identifies which types of records (allergies, drugs, lab results, referrals, etc.) should be returned in discrete form. It is possible for a given type of information to be returned in both discrete and document form. If not specified, default is all data will be returned discretely. To retrieve no discrete data, use a null flavor of "NA". Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows filtering of the clinical summary to only include types of information required by the application and/or which it is capable of supporting. | 1 | Mand |
|
| REPC_MT000008CA.DocumentRecordTypes |
|---|
value : (ActEventCategoryWorkingListCode)  Business name: Y: Document Record Types Identifies which types of records (allergies, drugs, lab results, referrals, etc.) should be returned in rendered document form. It is possible for a given type of information to be returned in both discrete and document form. If not specified, default is all data will be returned in document form. To retrieve no rendered data, use a null flavor of "NA" Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows returning discrete data rendered into document form for applications not capable of displaying data retrieved in discrete form. | 1 | Mand |
| | REPC_MT000008CA.EHRRepositoryId |
|---|
value : II.BUS  Business name: Q: EHR Repository Id Filters the records retrieved to only include those records from a specific EHR repository. If unspecified, all "connected" EHR repositories will be searched. Primarily intended to allow filtering an initial search to a local EHR repository for performance reasons. | 1 | Mand |
|
| REPC_MT000008CA.EffectiveTimeRange |
|---|
value : IVL<TS.FULLDATETIME>  Business name: J: Effective Time Range Filters the set of records to be retrieved to those which occurred or were effective for the patient within the time boundaries specified. Either the lower bound or upper bound or both would be specified. If no value is specified, no filter will be applied. If there is any overlap between the specified time-range and the effective time of the record, the record will be returned. Allows constraining the retrieved records to those applicable at a particular time. Useful in retrieving those records "currently in effect" as well as retrieving views of what information was in effect at some point in the past. | 1 | Mand |
| | REPC_MT000008CA.EventLocationId |
|---|
value : II.PUBLIC  Business name: O: Event Location Id Filters the records retrieved to only include those records which are officially associated with and/or were performed by a particular facility. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location id. Records associated with "sub-locations" (e.g. departments, wards) will be returned when searching by the larger location (e.g. hospital). Allows retrieving those records associated with a particular facility. | 1 | Mand |
|
| REPC_MT000008CA.EventLocationType |
|---|
value : (ServiceDeliveryLocationRoleType)  Business name: P: Event Location Type Filters the records retrieved to only include those records which are officially associated with and/or were performed by facilities with the specified type. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location type. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records associated with a particular kind of facility. E.g. Hospital, clinic, pharmacy, patient residence, etc. | 1 | Mand |
| | REPC_MT000008CA.FilterTemplateId |
|---|
value : II.BUS  Business name: W: Filter Template Id Indicates that the returned results are to be filtered acording to the specified template. If not specified, no filter is applied. The specific types of templates available are undefined and may vary by jurisdiction. Allows the application of complex filtering rules such as "All information relevant to diabetes management" or "cardiologist view of patient record". The query allows distinct filters to be applied to different types of records. E.g. all allergies, only most recent lab tests of a particular type, drugs of one of 5 types, etc. In some cases, the template may influence how document views of different information types are rendered. | 1 | Mand |
|
| REPC_MT000008CA.HealthCondition |
|---|
value : CD (ActHealthConditionType)  Business name: T: Health Conditions Filters the records retrieved to only include those associated with the specified health condition (e.g. has indication, discharge diagnosis, condition type, etc. Specifically, any record having an "indication" which matches the specified code, any Care composition or Discharge-Care Summary with a discharge disposition which matches the specified code, or any Coded Observation which matches the specified code and any Health Condition which matches the specified code). If there are episodes associated with the condition, the query will also return records associated with that episode. (I.e. Any record tied to an episode with an associated health condition has an implicit relationship to that health condition.) If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular health condition or problem. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
| | REPC_MT000008CA.Indication |
|---|
value : CD (ActIndicationType)  Business name: U: Indication Filters the records retrieved to only include those where the "indication" (reason) for the record was the specified code. This is distinct from the Health Condition query parameter in that it will only return records with an explicit indication match (it will not match on discharge diagnosis, part of related episode, etc.) It also allows searching on indications such as prophylaxis, surgery prep, etc. Allows retrieving all records associated with a particular indication. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| REPC_MT000008CA.MostRecentByTypeIndicator |
|---|
value :  Business name: V: Most Recent By Type Indicator If true, indicates that only the most recent records of a given type or category should be retrieved. I.e. If there are 10 records of the same kind, only the most recent one would be returned. If false, all occurrences will be returned. Provides a mechanism of getting a quick overview of the types of events that have occurred without needing to look at all occurrences. The attribute is mandatory because it must be known whether to return the most recent or all records. | 1 | Mand |
| |
| REPC_MT000008CA.ProtocolId |
|---|
value : II.BUS  Business name: ZI: Protocol Ids Filters the records retrieved to only include those associated with the specified protocols. If unspecified, no filter is applied. Allows retrieving records associated with a particular protocol. Useful in clinical studies and other research. The element is optional because support for protocols is not deemed a neccesity for many healthcare providers. | 1 | Mand |
| | REPC_MT000008CA.RecordStatus |
|---|
value : (ActStatus)  Business name: I: Record Statuses Filters the set of records to be retrieved to only include those with the identified status(s). If no values are specified, no filter will be applied. Allows constraining the status of records to be retrieved. Multiple repetitions are present to allow selection of multiple statuses with a single query. | 1 | Mand |
|
| REPC_MT000008CA.RecordType |
|---|
value : CD (ActCode)  Business name: H:Record Types Filters the type(s) or category(ies) of the records to be retrieved. The query will return both those records whose type exactly matches, as well as those whose types are subsets of the specified parameter. If no Types are specified, no restriction will be placed on the types to be returned. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows constraining the type of records to be retrieved. Multiple repetitions are present to allow selection of multiple types with a single query. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
| | REPC_MT000008CA.RequestingProviderId |
|---|
value : II.BUS  Business name: N: Requesting Provider Id Filters the records retrieved to only include those whose creation/performance were requested by the identified provider. If unspecified, no filter is applied. Allows a provider to see the results of any requests they may have made. | 1 | Mand |
|
| REPC_MT000008CA.ResponsibleProviderId |
|---|
value : II.PUBLIC  Business name: L: Responsible Provider Id Filters the records retrieved to only include those where the identified provider was the author, supervisor or performer. If unspecified, no filter is applied. Allows retrieving those records in which a particular provider has a vested interest. | 1 | Mand |
| | REPC_MT000008CA.ResponsibleProviderType |
|---|
value : (HealthcareProviderRoleType)  Business name: M: Responsible Provider Type Filters the records retrieved to only include those where the author, supervisor or performer was of the specified provider type. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records in which a particular kind of provider has a vested interest. | 1 | Mand |
|
|
|
|
|---|
| REPC_MT000010CA.Author  Business name: *a:authored by This identifies the provider who is responsible for the decision to capture the Health Condition in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. AllergyIntolerance.authorizingProvider ZPB1.3 AllergyIntolerance.authorizingPhysician |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Authored Datetime Indicates the time the decision to record when the Health Condition was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
|
REPC_MT000010CA.Author3  Business name: *last amended by This identifies the provider who most recently amended the Health Condition. The most recent Amending Provider has significant responsibility for the "current appearance" of the record and can have considerable influence on how other providers will interpret the validity and significance of the record. The element is mandatory because it should always be known by the EHR. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: Amend Datetime This indicates the last time a change was made to the Health Condition. It can be used by PoS applications to sort or filter records. Also provides information on how recently the record has changed. Because the element should always be known by the EHR, it is mandatory. | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
REPC_MT000010CA.ConditionEvent  Business name: Health Condition A record of a patient's health condition, as tracked over time. Examples include diseases, disabilities, pregnancy, lactation and other clinical conditions of interest. Also known as "Problem" (from a 'problem list'). Necessary component of a person's overall profile. Helps with contraindication checking. Code is fixed DX if not using SNOMED; Code is fixed to 'Assertion' if using SNOMED |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A:Condition Identifier A globally unique identifier assigned by the EHR to the Health Condition record. The identifier applies to this "instance" of the condition. For example, multiple pregnancies would each be treated as distinct conditions, each with a unique id. Allows for unique identification of the Health Condition and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 2 | Mand | code : (ActCode)  Business name: B: Condition Type Designates the concept in DiagnosisValue as a Diagnosis Condition Type is used for searching and for organizing Health Condition records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. Since all diagnosis concepts can be represented in a single field, this domain is a fixed value | 1 | Mand | negationInd :  Business name: E: Refuted Indicator When set to true, specifically flags the Health Condition record as "did not occur". The default is false. Additional details about the reasons for refuting the record may be conveyed in notes. This is primarily used to supersede records where an assertion was made that is subsequently determined to be false. It is important to be able to make explicit statements that something is known to not be true. This element is mandatory because it should always be known whether the record is being refuted or not. | 1 | Mand | statusCode : (ActStatus)  Business name: C:Condition Status This identifies the current state of the Health Condition record. Indicates whether the condition is still being monitored as relevant to the patient's health ('active') or whether the condition is no longer considered a relevant 'problem' ('completed'). It may also be 'obsolete' in circumstances where the record has been replaced. Note that a problem may be considered 'active' even if the underlying condition is no longer affecting the patient. For example, for a patient who was recently pregnant, the pregnancy has ended, but the pregnancy would still be an 'active' condition record because of it's ongoing impact on the patient's healthcare situation. To convey the actual clinical status of the condition, use SNOMED post-coordination in the Condition attribute. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Health Condition record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATE>  Business name: G: Condition Time Period The date on which the condition first began and when it ended. For ongoing conditions such as chronic diseases, the upper boundary may be unknown. For transient conditions such as pregnancy, lactation, etc; the upper boundary of the period would usually be specified to signify the end of the condition. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 0-1 | Req | confidentialityCode : SET<CV> (x_NormalRestrictedTabooConfidentialityKind)  Business name: F: Condition Masking Indicators 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Req | value : CD (DiagnosisValue)  Business name: K:Condition A code indicating the specific condition. E.g. Hypertension, Pregnancy. This is the central piece of information in recording a condition, therefore the attribute is mandatory. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Condition 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 | | responsibleParty : ResponsibleParty | 1 | Mand | | author : Author | 1 | Mand | | informant : Informant | 0-1 | Req | | custodian1 : Custodian2 | 1 | Mand | | custodian2 : Custodian | 1 | Mand | | predecessor : Predecessor | 0-10 | Req | | replacementOf : ReplacementOf | 0-1 | Req | | successor : Predecessor2 | 0-1 | Req | | subjectOf1 : Subject | 0-1 | Req | | subjectOf2 : Subject3 | 0-100 | Req | | subjectOf3 : Subject7 | 0-1 | Req | | subjectOf4 : Subject6 | 0-1 | Req | | componentOf : Component | 0-100 | Req |
| REPC_MT000010CA.ControlActEvent  Business name: Amendment Summary Identifies information about the most recent change to the Health Condition including when it was made, by whom and why. Provides context information about the record. |
|---|
classCode : "CACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | reasonCode : (ControlActReason)  Business name: B:Amend Reason This indicates the reason for most recent amendment to the record as indicated by the person who made the change. Understanding the reason for the most recent amendment provides context for the current state of the record. The element uses CWE to allow for the capture of Amend Reason 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. | 0-1 | Req | | author : Author3 | 1 | Mand |
|
| |
| |
| |
| |
REPC_MT000010CA.ResponsibleParty  Business name: c:supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Health Condition. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| |
|
|
|
|
|---|
| REPC_MT000014CA.ConditionEvent  Business name: Health Condition A record of a patient's health condition, as tracked over time. Examples include diseases, disabilities, pregnancy, lactation and other clinical conditions of interest. Also known as "Problem" (from a 'problem list'). Necessary component of a person's overall profile. Helps with contraindication checking. Code is fixed DX if not using SNOMED; Code is fixed to 'Assertion' if using SNOMED |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A:Condition Identifier A globally unique identifier assigned by the EHR to the Health Condition record. The identifier applies to this "instance" of the condition. For example, multiple pregnancies would each be treated as distinct conditions, each with a unique id. Allows for unique identification of the Health Condition and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 2 | Mand | code : (ActCode)  Business name: B: Condition Type Designates the concept in DiagnosisValue as a Diagnosis Condition Type is used for searching and for organizing Health Condition records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. Since all diagnosis concepts can be represented in a single field, this domain is a fixed value | 1 | Mand | statusCode : (ActStatus)  Business name: C:Condition Status This identifies the current state of the Health Condition record. Indicates whether the condition is still being monitored as relevant to the patient's health ('active') or whether the condition is no longer considered a relevant 'problem' ('completed'). It may also be 'obsolete' in circumstances where the record has been replaced. Note that a problem may be considered 'active' even if the underlying condition is no longer affecting the patient. For example, for a patient who was recently pregnant, the pregnancy has ended, but the pregnancy would still be an 'active' condition record because of it's ongoing impact on the patient's healthcare situation. To convey the actual clinical status of the condition, use SNOMED post-coordination in the Condition attribute. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Health Condition record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATE>  Business name: G: Condition Time Period The date on which the condition first began and when it ended. For ongoing conditions such as chronic diseases, the upper boundary may be unknown. For transient conditions such as pregnancy, lactation, etc; the upper boundary of the period would usually be specified to signify the end of the condition. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. | 0-1 | Req | confidentialityCode : SET<CV> (x_NormalRestrictedTabooConfidentialityKind)  Business name: F: Condition Masking Indicators 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | value : CD (DiagnosisValue)  Business name: K:Condition A code indicating the specific condition. E.g. Hypertension, Pregnancy. This is the central piece of information in recording a condition, therefore the attribute is mandatory. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Condition 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 | | informant : Informant | 0-1 | Req | | componentOf : Component | 0-100 | Req |
|
|
|
|
|
|---|
| REPC_MT000015CA.AmendedSinceDateTime |
|---|
value : TS.FULLDATETIME  Business name: K: Updated Since DateTime Filters the records retrieved to only include those which have been created or revised since the specified date and time. If unspecified, no filter is applied. Useful to retrieve information "since you last checked". | 1 | Mand |
| | REPC_MT000015CA.CareCompositionId |
|---|
value : II.BUS  Business name: R: Care Composition Ids Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied. Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral. Allows retrieving all records associated with an encounter, episode or care event. | 1 | Mand |
|
| REPC_MT000015CA.CareCompositionType |
|---|
value : (ActCareEventType)  Business name: S: Care Composition Types Filters the records retrieved to only include those associated with the specified 'kind' of encounter, episode or care event. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular type of encounter, episode or care event. E.g.Orthopedic Clinic Encounter, ER encounter, Walk-in encounter, etc. | 1 | Mand |
| | REPC_MT000015CA.EHRRepositoryId |
|---|
value : II.BUS  Business name: Q: EHR Repository Id Filters the records retrieved to only include those records from a specific EHR repository. If unspecified, all "connected" EHR repositories will be searched. Primarily intended to allow filtering an initial search to a local EHR repository for performance reasons. | 1 | Mand |
|
| REPC_MT000015CA.EffectiveTimeRange |
|---|
value : IVL<TS.FULLDATETIME>  Business name: J: Effective Time Range Filters the set of records to be retrieved to those which occurred or were effective for the patient within the time boundaries specified. Either the lower bound or upper bound or both would be specified. If no value is specified, no filter will be applied. If there is any overlap between the specified time-range and the effective time of the record, the record will be returned. Allows constraining the retrieved records to those applicable at a particular time. Useful in retrieving those records "currently in effect" as well as retrieving views of what information was in effect at some point in the past. | 1 | Mand |
| | REPC_MT000015CA.EventLocationId |
|---|
value : II.PUBLIC  Business name: O: Event Location Id Filters the records retrieved to only include those records which are officially associated with and/or were performed by a particular facility. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location id. Records associated with "sub-locations" (e.g. departments, wards) will be returned when searching by the larger location (e.g. hospital). Allows retrieving those records associated with a particular facility. | 1 | Mand |
|
| REPC_MT000015CA.EventLocationType |
|---|
value : (ServiceDeliveryLocationRoleType)  Business name: P: Event Location Type Filters the records retrieved to only include those records which are officially associated with and/or were performed by facilities with the specified type. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location type. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records associated with a particular kind of facility. E.g. Hospital, clinic, pharmacy, patient residence, etc. | 1 | Mand |
| | REPC_MT000015CA.HealthCondition |
|---|
value : CD (ActHealthConditionType)  Business name: T: Health Conditions Filters the records retrieved to only include those associated with the specified health condition (e.g. has indication, discharge diagnosis, condition type, etc. Specifically, any record having an "indication" which matches the specified code, any Care composition or Discharge-Care Summary with a discharge disposition which matches the specified code, or any Coded Observation which matches the specified code and any Health Condition which matches the specified code). If there are episodes associated with the condition, the query will also return records associated with that episode. (I.e. Any record tied to an episode with an associated health condition has an implicit relationship to that health condition.) If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular health condition or problem. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| REPC_MT000015CA.MostRecentByTypeIndicator |
|---|
value :  Business name: V: Most Recent By Type Indicator If true, indicates that only the most recent records of a given type or category should be retrieved. I.e. If there are 10 records of the same kind, only the most recent one would be returned. If false, all occurrences will be returned. Provides a mechanism of getting a quick overview of the types of events that have occurred without needing to look at all occurrences. The attribute is mandatory because it must be known whether to return the most recent or all records. | 1 | Mand |
| |
| REPC_MT000015CA.ProtocolId |
|---|
value : II.BUS  Business name: ZI: Protocol Ids Filters the records retrieved to only include those associated with the specified protocols. If unspecified, no filter is applied. Allows retrieving records associated with a particular protocol. Useful in clinical studies and other research. The element is optional because support for protocols is not deemed a neccesity for many healthcare providers. | 1 | Mand |
| | REPC_MT000015CA.RecordStatus |
|---|
value : (ActStatus)  Business name: I: Record Statuses Filters the set of records to be retrieved to only include those with the identified status(s). If no values are specified, no filter will be applied. Allows constraining the status of records to be retrieved. Multiple repetitions are present to allow selection of multiple statuses with a single query. | 1 | Mand |
|
| REPC_MT000015CA.RecordType |
|---|
value : CD (DX)  Business name: H:Record Types Filters the type(s) or category(ies) of the records to be retrieved. The query will return both those records whose type exactly matches, as well as those whose types are subsets of the specified parameter. If no Types are specified, no restriction will be placed on the types to be returned. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows constraining the type of records to be retrieved. Multiple repetitions are present to allow selection of multiple types with a single query. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
| | REPC_MT000015CA.ResponsibleProviderId |
|---|
value : II.PUBLIC  Business name: L: Responsible Provider Id Filters the records retrieved to only include those where the identified provider was the author, supervisor or performer. If unspecified, no filter is applied. Allows retrieving those records in which a particular provider has a vested interest. | 1 | Mand |
|
| REPC_MT000015CA.ResponsibleProviderType |
|---|
value : (HealthcareProviderRoleType)  Business name: M: Responsible Provider Type Filters the records retrieved to only include those where the author, supervisor or performer was of the specified provider type. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records in which a particular kind of provider has a vested interest. | 1 | Mand |
|
|
|
|
|---|
| REPC_MT210001CA.ActRequest2 |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActProfessionalServiceCode)  Business name: H:Requested Service Acoded value denoting the specific service taht has been order through the referral. Helps to reconcile to service that is subsequently performed. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Requested Service 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 |
| REPC_MT210001CA.AssignedEntity  Business name: Provider Identifies the service provider or type of service provider who is being requested to deliver services to the patient. Represents a key piece of information about the referral. Included because the referral may be routed to a different person than that intended to actually deliver the service. Player association must be present if and only if id is present |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II.BUS  Business name: F: Provider Id A unique provider identifier such as the MINC #; (a unique lifetime identifier for physicians in Canada). Other health care professions such as nursing and dietitians have similar identifiers. For those providers (such as family members, friends, neighbors and others who are part of the patient's informal support network will not have identifiers) the system will assign identifiers for the purpose of linking information within the message. An identifier is the best way of kinking a provider to information in a provider registry, and therefore will be required in the absence of a provider name. For non-professional providers and others who do not have unique provider numbers, applications must create 'internal' identifiers to allow referencing of the provider within the message. | 0-1 | Req | code : (HealthcareProviderRoleType)  Business name: G: Provider Type Indicates the medical discipline of the provider. Provides important context to understanding information recorded by a provider and work intended to be performed by the provider. | 0-1 | Req | | assignedProvider : Provider | 0-1 | Req |
|
REPC_MT210001CA.Author  Business name: *a: authored by This identifies the provider who is responsible for the decision to capture the Referral in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | signatureCode : (ParticipationSignature)  Business name: K:Attested Indicator An indication that the provider attests to the authenticity of the document that he/she has authored. Important for assessing the level of 'officialness' of a document. Because it must always be known whether a document has been attested or not, the attribute is mandatory. | 1 | Mand |
| |
| | REPC_MT210001CA.Component3 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | | section : Section | 1 | Mand |
|
| | REPC_MT210001CA.Component5 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
|
| | REPC_MT210001CA.Component7 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
|
| REPC_MT210001CA.Document  Business name: Referral Represents a particular health-related document pertaining to a single patient. Allows the capture of patient health data in an encapsulated, contextualized manner with capability of displaying rendered content and communication between simple systems. |
|---|
classCode : "DOCCLIN" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (ReferralDocumentType)  Business name: B: Document Category Identifies the type of Referral represented by this record. e.g. referral, consult note, clinical summary. Document Category is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | title :  Business name: J: Document Title A human-readable label for this particular document. Titles do not necessarily need to be unique, but should be precise-enough to give a pretty good idea of what the document contains. For example "Right Knee Arthroscopy Report, Jan 3, 2006" would represent a good title. "Surgery Report" would not. This is a human-recognizable name intended to be displayed on the screen in list transactions and is therefore mandatory. It provides a good indication of the content of the document at a quick glance. | 1 | Mand | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: E: Document Masking Indicators Communicates the desire of the patient to restrict access to this Referral 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | | author : Author | 1 | Mand | | primaryInformationRecipient : InformationRecipient | 0-10 | Req | | predecessor : Predecessor2 | 0-10 | Req | | component : Component2 | 1 | Mand | | subjectOf : Subject4 | 0-1 | Req | | componentOf : Component6 | 0-100 | Req |
|
| |
| REPC_MT210001CA.Location3  Business name: v:referred to Indicates the service Delivery Location where the referral service is targeted to be preformed. The target site of the referral service provides context for interpreting the record. In some cases, it may also provide follow-up information If the referral was targeted to a service delivery location then the identity of the location must be known. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| | REPC_MT210001CA.PatientCareProvisionEvent2 |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: N: Referral Report Link A unique identifier for the report resulting from the action requested by this referral. This linkage may be established after the document has been created if the report provides a direct link to the referral. Provides a direct link between the referral and the resulting report. | 0-1 | Req |
|
REPC_MT210001CA.PatientCareProvisionRequest  Business name: C:Referral Discrete information about the type of care being requested. Provides contextual overview information for searching and filtering |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActCareProvisionRequestType)  Business name: C: Referral Type Concepts identifying different types of referral request document. These codes identify the general type of care services requested. They are not used to represent the indication or diagnosis which triggered the need for the referral. Referral Type is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : (x_ActStatusActiveComplete)  Business name: D: Referral Status This identifies the current state of the Referral record. If the status is 'active' it means the request is still outstanding or in progress. If the status is 'complete' it means that the referral has been acted upon and the referral is considered closed. If the status is 'aborted' it means the request made by the referral has been withdrawn. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Referral record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. It is important to note that the EHR is not expected to perform status management of referrals. Thus it is up to clinicians to amend the status of a referral when it has changed to complete. | 0-1 | Req | effectiveTime : IVL.LOW<TS.DATE>  Business name: F: Referral Requested By Time Indicates the target date by which the referring provider hopes the requested assessment could be completed. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. Identifies the time-period of relevance to the record which is useful in filtering and organizing "time-view" presentations of data. | 0-1 | Req | | performer : Performer | 0-1 | Req | | location : Location3 | 0-1 | Req | | component : Component8 | 0-1 | Req | | fulfillment : InFulfillmentOf2 | 0-1 | Req |
| |
| |
| |
| REPC_MT210001CA.Reference |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: L:Reference Record Links These identifiers allow for referencing other discrete records within the EHR which are considered relevant to the document as a whole or a particular section. For sections, the links may refer specifically to records which have been rendered as part of the section. The external references allow accessing discrete data for additional analysis and manipulation such as graphing, automated comparison or decision-support. | 1 | Mand |
| | REPC_MT210001CA.Section |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | text : ED.DOC  Business name: M: Document Overview Content Provides the primary rendered textual content of the document. E.g. The cover letter for a referral, the overview portion of a report, etc. There is no guidance provided within the standard on how report content should be organized or formatted. Guidance may be provided by professional colleges, specialty groups or others. Represents the principle content of the document and therefore is mandatory. | 1 | Mand | | component1 : Component4 | 1 | Mand | | component2 : Component | 0-100 | Req | | component3 : Component5 | 0-100 | Req |
|
| REPC_MT210001CA.SubSection  Business name: Document Sections Used to document additional relevant information about the patient such as allergies, medications, problem list, etc. Provides contextual information for understanding the Referral by sharing a filtered, rendered view of portions of the patient's record. |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (DocumentSectionType)  Business name: A: Section Type Identifies the type of Referral represented by this record. Examples: allergy list, problem list, medication list, etc. Section Type is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. The element uses CWE to allow for the capture of Section 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 | title :  Business name: B: Section Title Represents the label associated with this particular portion of the document. These are a human-readable equivalents to the Section Type code. E.g. "Allergies", "Assessment", "Recommendations", etc. Provides a human readable label for the section. Because it is used as part of the document rendering, the attribute is mandatory. | 1 | Mand | text : ED.DOC  Business name: M: Section Content Represents the rendered text content for the section. Provides a human-readable view of data that is accessible without sophisticated PoS applications. Allows data to be filtered and rendered in a manner to focus on the content deemed relevant by the author of the document. Because it coveys the content, the attribute mus be mandatory. | 1 | Mand | | component : Component7 | 0-100 | Req |
|
|
|
|
|
|---|
| REPC_MT210002CA.ActRequest2 |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActProfessionalServiceCode)  Business name: H:Requested Service Acoded value denoting the specific service taht has been order through the referral. Helps to reconcile to service that is subsequently performed. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Requested Service 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 |
| |
REPC_MT210002CA.AssignedEntity  Business name: Provider Identifies the service provider or type of service provider who is being requested to deliver services to the patient. Represents a key piece of information about the referral. Included because the referral may be routed to a different person than that intended to actually deliver the service. Player association must be present if and only if id is present |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II.BUS  Business name: F: Provider Id A unique provider identifier such as the MINC #; (a unique lifetime identifier for physicians in Canada). Other health care professions such as nursing and dietitians have similar identifiers. For those providers (such as family members, friends, neighbors and others who are part of the patient's informal support network will not have identifiers) the system will assign identifiers for the purpose of linking information within the message. An identifier is the best way of kinking a provider to information in a provider registry, and therefore will be required in the absence of a provider name. For non-professional providers and others who do not have unique provider numbers, applications must create 'internal' identifiers to allow referencing of the provider within the message. | 0-1 | Req | code : (HealthcareProviderRoleType)  Business name: G: Provider Type Indicates the medical discipline of the provider. Provides important context to understanding information recorded by a provider and work intended to be performed by the provider. | 0-1 | Req | | assignedProvider : Provider | 0-1 | Req |
| REPC_MT210002CA.Author  Business name: *a: authored by This identifies the provider who is responsible for the decision to capture the Referral in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: X: Authored Datetime Indicates the time the decision to record when the Referral was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | signatureCode : (ParticipationSignature)  Business name: K:Attested Indicator An indication that the provider attests to the authenticity of the document that he/she has authored. Important for assessing the level of 'officialness' of a document. Because it must always be known whether a document has been attested or not, 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 |
|
| | REPC_MT210002CA.Component3 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | | section : Section | 1 | Mand |
|
| |
| |
| REPC_MT210002CA.Document  Business name: Referral Represents a particular health-related document pertaining to a single patient. Allows the capture of patient health data in an encapsulated, contextualized manner with capability of displaying rendered content and communication between simple systems. Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
classCode : "DOCCLIN" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: A: Document Identifier A globally unique identifier assigned by the EHR to the Referral record. Allows for unique identification of the Referral and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 1 | Mand | code : (ReferralDocumentType)  Business name: B: Document Category Identifies the type of Referral represented by this record. e.g. referral, consult note, clinical summary. Document Category is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | title :  Business name: J: Document Title A human-readable label for this particular document. Titles do not necessarily need to be unique, but should be precise-enough to give a pretty good idea of what the document contains. For example "Right Knee Arthroscopy Report, Jan 3, 2006" would represent a good title. "Surgery Report" would not. This is a human-recognizable name intended to be displayed on the screen in list transactions and is therefore mandatory. It provides a good indication of the content of the document at a quick glance. | 1 | Mand | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: E: Document Masking Indicators Communicates the desire of the patient to restrict access to this Referral 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Req | | responsibleParty : ResponsibleParty | 1 | Mand | | author : Author | 1 | Mand | | custodian1 : Custodian2 | 1 | Mand | | custodian2 : Custodian | 1 | Mand | | primaryInformationRecipient : InformationRecipient | 0-10 | Req | | predecessor : Predecessor2 | 0-10 | Req | | component : Component2 | 1 | Mand | | successor : Predecessor | 0-1 | Req | | subjectOf1 : Subject4 | 0-1 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | componentOf : Component6 | 0-100 | Req |
|
| |
| REPC_MT210002CA.Location3  Business name: v:referred to Indicates the service Delivery Location where the referral service is targeted to be preformed. The target site of the referral service provides context for interpreting the record. In some cases, it may also provide follow-up information If the referral was targeted to a service delivery location then the identity of the location must be known. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
| REPC_MT210002CA.PatientCareProvisionEvent2 |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: N: Referral Report Link A unique identifier for the report resulting from the action requested by this referral. This linkage may be established after the document has been created if the report provides a direct link to the referral. Provides a direct link between the referral and the resulting report. | 0-1 | Req |
| REPC_MT210002CA.PatientCareProvisionRequest  Business name: C:Referral Discrete information about the type of care being requested. Provides contextual overview information for searching and filtering |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActCareProvisionRequestType)  Business name: C: Referral Type Concepts identifying different types of referral request document. These codes identify the general type of care services requested. They are not used to represent the indication or diagnosis which triggered the need for the referral. Referral Type is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : (x_ActStatusActiveComplete)  Business name: D: Referral Status This identifies the current state of the Referral record. If the status is 'active' it means the request is still outstanding or in progress. If the status is 'complete' it means that the referral has been acted upon and the referral is considered closed. If the status is 'aborted' it means the request made by the referral has been withdrawn. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Referral record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. It is important to note that the EHR is not expected to perform status management of referrals. Thus it is up to clinicians to amend the status of a referral when it has changed to complete. | 0-1 | Req | effectiveTime : IVL.LOW<TS.DATE>  Business name: F: Referral Requested By Time Indicates the target date by which the referring provider hopes the requested assessment could be completed. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. Identifies the time-period of relevance to the record which is useful in filtering and organizing "time-view" presentations of data. | 0-1 | Req | | performer : Performer | 0-1 | Req | | location : Location3 | 0-1 | Req | | component : Component8 | 0-1 | Req | | fulfillment : InFulfillmentOf2 | 0-1 | Req |
|
| |
| |
| |
REPC_MT210002CA.ResponsibleParty  Business name: *b: supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Referral. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| |
| |
|
|
|
|
|---|
| REPC_MT210003CA.ActRequest2 |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActProfessionalServiceCode)  Business name: H:Requested Service Acoded value denoting the specific service taht has been order through the referral. Helps to reconcile to service that is subsequently performed. This element makes use of the CD datatype because some terminologies used for the domain require use of modifiers. The element uses CWE to allow for the capture of Requested Service 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 |
| |
REPC_MT210003CA.AssignedEntity  Business name: Provider Identifies the service provider or type of service provider who is being requested to deliver services to the patient. Represents a key piece of information about the referral. Included because the referral may be routed to a different person than that intended to actually deliver the service. Player association must be present if and only if id is present |
|---|
classCode : "ASSIGNED" (RoleClass) | 1 | Mand | id : II.BUS  Business name: F: Provider Id A unique provider identifier such as the MINC #; (a unique lifetime identifier for physicians in Canada). Other health care professions such as nursing and dietitians have similar identifiers. For those providers (such as family members, friends, neighbors and others who are part of the patient's informal support network will not have identifiers) the system will assign identifiers for the purpose of linking information within the message. An identifier is the best way of kinking a provider to information in a provider registry, and therefore will be required in the absence of a provider name. For non-professional providers and others who do not have unique provider numbers, applications must create 'internal' identifiers to allow referencing of the provider within the message. | 0-1 | Req | code : (HealthcareProviderRoleType)  Business name: G: Provider Type Indicates the medical discipline of the provider. Provides important context to understanding information recorded by a provider and work intended to be performed by the provider. | 0-1 | Req | | assignedProvider : Provider | 0-1 | Req |
| REPC_MT210003CA.Author  Business name: *a: authored by This identifies the provider who is responsible for the decision to capture the Referral in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | time : TS.FULLDATETIME  Business name: X: Authored Datetime Indicates the time the decision to record when the Referral was made. This will usually be simultaneous with the time the record is submitted to the EHR, but in some circumstances may be before. Used to allow for historical sequencing of records in the EHR, which facilitates auditing, sorting etc. This attribute is populated because it won't always be known in the circumstance where the data is being entered by a person other than the original "creator" of the record. | 1 | Pop | signatureCode : (ParticipationSignature)  Business name: K:Attested Indicator An indication that the provider attests to the authenticity of the document that he/she has authored. Important for assessing the level of 'officialness' of a document. Because it must always be known whether a document has been attested or not, 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 |
|
| |
| REPC_MT210003CA.Component3 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | | section : Section | 1 | Mand |
| |
| REPC_MT210003CA.Component5 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
| |
| REPC_MT210003CA.Component7 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
| |
| |
REPC_MT210003CA.Document  Business name: Referral Represents a particular health-related document pertaining to a single patient. Allows the capture of patient health data in an encapsulated, contextualized manner with capability of displaying rendered content and communication between simple systems. Annotation is only permitted if Annotation Indicator is not present and vice versa |
|---|
classCode : "DOCCLIN" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : SET<II.BUS_AND_VER>  Business name: A: Document Identifiers A globally unique identifier assigned by the EHR to the Referral record. Allows for unique identification of the Referral and is therefore mandatory. Supports drill-down queries, linking of this record to other records, matching of EHR records to locally-stored PoS records and is necessary when identifying records for amending (revising)/directional linking (superseding). | 2 | Mand | code : (ReferralDocumentType)  Business name: B: Document Category Identifies the type of Referral represented by this record. e.g. referral, consult note, clinical summary. Document Category is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | title :  Business name: J: Document Title A human-readable label for this particular document. Titles do not necessarily need to be unique, but should be precise-enough to give a pretty good idea of what the document contains. For example "Right Knee Arthroscopy Report, Jan 3, 2006" would represent a good title. "Surgery Report" would not. This is a human-recognizable name intended to be displayed on the screen in list transactions and is therefore mandatory. It provides a good indication of the content of the document at a quick glance. | 1 | Mand | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: E: Document Masking Indicators Communicates the desire of the patient to restrict access to this Referral 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Req | | responsibleParty : ResponsibleParty | 1 | Mand | | author : Author | 1 | Mand | | custodian1 : Custodian2 | 1 | Mand | | custodian2 : Custodian | 1 | Mand | | primaryInformationRecipient : InformationRecipient | 0-10 | Req | | predecessor : Predecessor2 | 0-10 | Req | | component : Component2 | 1 | Mand | | successor : Predecessor | 0-1 | Req | | subjectOf1 : Subject4 | 0-1 | Req | | subjectOf2 : Subject3 | 0-1 | Req | | componentOf : Component6 | 0-100 | Req |
| |
| |
REPC_MT210003CA.Location3  Business name: v:referred to Indicates the service Delivery Location where the referral service is targeted to be preformed. The target site of the referral service provides context for interpreting the record. In some cases, it may also provide follow-up information If the referral was targeted to a service delivery location then the identity of the location must be known. |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 0-1 | Req | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
| |
| | REPC_MT210003CA.PatientCareProvisionEvent2 |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: N: Referral Report Link A unique identifier for the report resulting from the action requested by this referral. This linkage may be established after the document has been created if the report provides a direct link to the referral. Provides a direct link between the referral and the resulting report. | 0-1 | Req |
|
REPC_MT210003CA.PatientCareProvisionRequest  Business name: C:Referral Discrete information about the type of care being requested. Provides contextual overview information for searching and filtering |
|---|
classCode : "PCPR" (ActClass) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | code : CD (ActCareProvisionRequestType)  Business name: C: Referral Type Concepts identifying different types of referral request document. These codes identify the general type of care services requested. They are not used to represent the indication or diagnosis which triggered the need for the referral. Referral Type is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : (x_ActStatusActiveComplete)  Business name: D: Referral Status This identifies the current state of the Referral record. If the status is 'active' it means the request is still outstanding or in progress. If the status is 'complete' it means that the referral has been acted upon and the referral is considered closed. If the status is 'aborted' it means the request made by the referral has been withdrawn. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Referral record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. It is important to note that the EHR is not expected to perform status management of referrals. Thus it is up to clinicians to amend the status of a referral when it has changed to complete. | 0-1 | Req | effectiveTime : IVL.LOW<TS.DATE>  Business name: F: Referral Requested By Time Indicates the target date by which the referring provider hopes the requested assessment could be completed. Identifies the time-period of relevance to the record that is useful in filtering and organizing "time-view" presentations of data. Because the timing information won't always be known, this attribute is marked as 'populated'. Identifies the time-period of relevance to the record which is useful in filtering and organizing "time-view" presentations of data. | 0-1 | Req | | performer : Performer | 0-1 | Req | | location : Location3 | 0-1 | Req | | component : Component8 | 0-1 | Req | | fulfillment : InFulfillmentOf2 | 0-1 | Req |
| |
| |
| |
| | REPC_MT210003CA.Reference |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: L:Reference Record Links These identifiers allow for referencing other discrete records within the EHR which are considered relevant to the document as a whole or a particular section. For sections, the links may refer specifically to records which have been rendered as part of the section. The external references allow accessing discrete data for additional analysis and manipulation such as graphing, automated comparison or decision-support. | 1 | Mand |
|
REPC_MT210003CA.ResponsibleParty  Business name: *b: supervised by This identifies the person that has primary responsibility for the actions of the author in creating the Referral. The supervising provider is not necessarily present when the action is performed, but is professionally accountable for the action through the power to delegate, and the duty to review actions with the performing actor after the fact. If not specified, it is assumed that the author is acting under their own professional authority. I.e. If the author and supervisor are the same, only the author should be in the instance. Needed in circumstances where one provider is acting under the professional authority of another. E.g. Pharmacy technician under pharmacist, resident under supervising physician, etc. Tracking responsibility is essential for authorization and regulatory purposes and is therefore mandatory. It also provides a secondary person to contact for follow-up. |
|---|
typeCode : "RESP" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | | Choice: actingPerson : ActingPerson | 1 | Mand | | »» assignedEntity1 : AssignedEntity | 0-1 | Opt | | »» assignedEntity2 : AssignedEntity | 0-1 | Opt | | »» personalRelationship : PersonalRelationship | 0-1 | Opt |
| | REPC_MT210003CA.Section |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | text : ED.DOC  Business name: M: Document Overview Content Provides the primary rendered textual content of the document. E.g. The cover letter for a referral, the overview portion of a report, etc. There is no guidance provided within the standard on how report content should be organized or formatted. Guidance may be provided by professional colleges, specialty groups or others. Represents the principle content of the document and therefore is mandatory. | 1 | Mand | | component1 : Component4 | 1 | Mand | | component2 : Component | 0-100 | Req | | component3 : Component5 | 0-100 | Req |
|
| REPC_MT210003CA.SubSection  Business name: Document Sections Used to document additional relevant information about the patient such as allergies, medications, problem list, etc. Provides contextual information for understanding the Referral by sharing a filtered, rendered view of portions of the patient's record. |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (DocumentSectionType)  Business name: A: Section Type Identifies the type of Referral represented by this record. Examples: allergy list, problem list, medication list, etc. Section Type is used for searching and for organizing Referral records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. The element uses CWE to allow for the capture of Section 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 | title :  Business name: B: Section Title Represents the label associated with this particular portion of the document. These are a human-readable equivalents to the Section Type code. E.g. "Allergies", "Assessment", "Recommendations", etc. Provides a human readable label for the section. Because it is used as part of the document rendering, the attribute is mandatory. | 1 | Mand | text : ED.DOC  Business name: M: Section Content Represents the rendered text content for the section. Provides a human-readable view of data that is accessible without sophisticated PoS applications. Allows data to be filtered and rendered in a manner to focus on the content deemed relevant by the author of the document. Because it coveys the content, the attribute mus be mandatory. | 1 | Mand | | component : Component7 | 0-100 | Req |
|
| |
|
|
|
|---|
| REPC_MT210004CA.AmendedSinceDateTime |
|---|
value : TS.FULLDATETIME  Business name: K: Updated Since DateTime Filters the records retrieved to only include those which have been created or revised since the specified date and time. If unspecified, no filter is applied. Useful to retrieve information "since you last checked". | 1 | Mand |
| | REPC_MT210004CA.AttestedIndicator |
|---|
value :  Business name: ZM: Attested Indicator If specified, filters the returned documents to only include those which have been attested as correct by the document author or which have not been authenticated. If not specified, both attested and non-attested documents will be returned. Relevant for transcribed reports (e.g. the data enterer is different than the 'author'). Records where "attestation" is marked as "Not applicable" will be treated as attested. Allows filtering to only see those documents which are "known" to be accurate. May also be used to retrieve documents associated with a provider which are unauthenticated. | 1 | Mand |
|
| REPC_MT210004CA.CareCompositionId |
|---|
value : II.BUS  Business name: R: Care Composition Ids Filters the records retrieved to only include those associated with the specified encounter, episode or care event. If unspecified, no filter is applied. Note: When matching on care composition id, systems should also retrieve records with a fulfillment id to requisitions associated with the care composition. E.g. When retrieving records associated with an encounter which includes a referral, the retrieved records should also include the care summary created in fulfillment of the referral. Allows retrieving all records associated with an encounter, episode or care event. | 1 | Mand |
| | REPC_MT210004CA.CareCompositionType |
|---|
value : (ActCareEventType)  Business name: S: Care Composition Types Filters the records retrieved to only include those associated with the specified 'kind' of encounter, episode or care event. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular type of encounter, episode or care event. E.g.Orthopedic Clinic Encounter, ER encounter, Walk-in encounter, etc. | 1 | Mand |
|
| REPC_MT210004CA.EHRRepositoryId |
|---|
value : II.BUS  Business name: Q: EHR Repository Id Filters the records retrieved to only include those records from a specific EHR repository. If unspecified, all "connected" EHR repositories will be searched. Primarily intended to allow filtering an initial search to a local EHR repository for performance reasons. | 1 | Mand |
| | REPC_MT210004CA.EffectiveTimeRange |
|---|
value : IVL<TS.FULLDATETIME>  Business name: J: Effective Time Range Filters the set of records to be retrieved to those which occurred or were effective for the patient within the time boundaries specified. Either the lower bound or upper bound or both would be specified. If no value is specified, no filter will be applied. If there is any overlap between the specified time-range and the effective time of the record, the record will be returned. Allows constraining the retrieved records to those applicable at a particular time. Useful in retrieving those records "currently in effect" as well as retrieving views of what information was in effect at some point in the past. | 1 | Mand |
|
| REPC_MT210004CA.EventCategory |
|---|
value : (ReferralDocumentType)  Business name: ZJ: Event Categories If specified, filters the returned records to those having the specified category. E.g. "Allergy/Intolerance", "Measured Observation", "Cognitive Procedure". (Contrast this with "Type" which would allow searching for "Drug Allergies", "Patient Weight" and "Smoking Cessation Counseling".) Allows filtering responses based on higher level categorization. Multiple repetitions are supported to allow for multiple categories to be returned. | 1 | Mand |
| | REPC_MT210004CA.EventLocationId |
|---|
value : II.PUBLIC  Business name: O: Event Location Id Filters the records retrieved to only include those records which are officially associated with and/or were performed by a particular facility. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location id. Records associated with "sub-locations" (e.g. departments, wards) will be returned when searching by the larger location (e.g. hospital). Allows retrieving those records associated with a particular facility. | 1 | Mand |
|
| REPC_MT210004CA.EventLocationType |
|---|
value : (ServiceDeliveryLocationRoleType)  Business name: P: Event Location Type Filters the records retrieved to only include those records which are officially associated with and/or were performed by facilities with the specified type. I.e. It will return records where either the "Service Location" or the "Record Location" has the specified location type. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records associated with a particular kind of facility. E.g. Hospital, clinic, pharmacy, patient residence, etc. | 1 | Mand |
| | REPC_MT210004CA.HealthCondition |
|---|
value : CD (ActHealthConditionType)  Business name: T: Health Conditions Filters the records retrieved to only include those associated with the specified health condition (e.g. has indication, discharge diagnosis, condition type, etc. Specifically, any record having an "indication" which matches the specified code, any Care composition or Discharge-Care Summary with a discharge disposition which matches the specified code, or any Coded Observation which matches the specified code and any Health Condition which matches the specified code). If there are episodes associated with the condition, the query will also return records associated with that episode. (I.e. Any record tied to an episode with an associated health condition has an implicit relationship to that health condition.) If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving all records associated with a particular health condition or problem. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| REPC_MT210004CA.Indication |
|---|
value : CD (ActIndicationType)  Business name: U: Indication Filters the records retrieved to only include those where the "indication" (reason) for the record was the specified code. This is distinct from the Health Condition query parameter in that it will only return records with an explicit indication match (it will not match on discharge diagnosis, part of related episode, etc.) It also allows searching on indications such as prophylaxis, surgery prep, etc. Allows retrieving all records associated with a particular indication. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
| | REPC_MT210004CA.MostRecentByTypeIndicator |
|---|
value :  Business name: V: Most Recent By Type Indicator If true, indicates that only the most recent records of a given type or category should be retrieved. I.e. If there are 10 records of the same kind, only the most recent one would be returned. If false, all occurrences will be returned. Provides a mechanism of getting a quick overview of the types of events that have occurred without needing to look at all occurrences. The attribute is mandatory because it must be known whether to return the most recent or all records. | 1 | Mand |
|
| | REPC_MT210004CA.ProtocolId |
|---|
value : II.BUS  Business name: ZI: Protocol Ids Filters the records retrieved to only include those associated with the specified protocols. If unspecified, no filter is applied. Allows retrieving records associated with a particular protocol. Useful in clinical studies and other research. The element is optional because support for protocols is not deemed a neccesity for many healthcare providers. | 1 | Mand |
|
| REPC_MT210004CA.RecipientLocationId |
|---|
value : II.PUBLIC  Business name: ZO: Recipient Location Id If specified, filters the returned documents to only include those which were targeted to the specified location. If not specified, no filter is applied Allows retrieval of all documents sent to a particular location. E.g. "Find all documents targeted to my location" | 1 | Mand |
| | REPC_MT210004CA.RecipientProviderId |
|---|
value : II.PUBLIC  Business name: ZN: Recipient Provider Id If specified, filters the returned documents to only include those which were targeted to the specified provider. If not specified, no filter is applied Allows retrieval of all documents sent to a particular provider. E.g. "Find all documents targeted to me" | 1 | Mand |
|
| REPC_MT210004CA.RecordStatus |
|---|
value : (ActStatus)  Business name: I: Record Statuses Filters the set of records to be retrieved to only include those with the identified status(s). If no values are specified, no filter will be applied. Allows constraining the status of records to be retrieved. Multiple repetitions are present to allow selection of multiple statuses with a single query. | 1 | Mand |
| | REPC_MT210004CA.RecordType |
|---|
value : CD (ActCareProvisionRequestType)  Business name: H:Record Types Filters the type(s) or category(ies) of the records to be retrieved. The query will return both those records whose type exactly matches, as well as those whose types are subsets of the specified parameter. If no Types are specified, no restriction will be placed on the types to be returned. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows constraining the type of records to be retrieved. Multiple repetitions are present to allow selection of multiple types with a single query. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand |
|
| REPC_MT210004CA.RequestingProviderId |
|---|
value : II.BUS  Business name: N: Requesting Provider Id Filters the records retrieved to only include those whose creation/performance were requested by the identified provider. If unspecified, no filter is applied. Allows a provider to see the results of any requests they may have made. | 1 | Mand |
| | REPC_MT210004CA.ResponsibleProviderId |
|---|
value : II.PUBLIC  Business name: L: Responsible Provider Id Filters the records retrieved to only include those where the identified provider was the author, supervisor or performer. If unspecified, no filter is applied. Allows retrieving those records in which a particular provider has a vested interest. | 1 | Mand |
|
| REPC_MT210004CA.ResponsibleProviderType |
|---|
value : (HealthcareProviderRoleType)  Business name: M: Responsible Provider Type Filters the records retrieved to only include those where the author, supervisor or performer was of the specified provider type. If unspecified, no filter is applied. Query results should include those with an match of this code, as well those matching any specializations of the coded parameter. Allows retrieving those records in which a particular kind of provider has a vested interest. | 1 | Mand |
|
|
|
|
|---|
REPC_MT220001CA.ActRequest  Business name: Request A particular request (referral or specific request) that resulted in the creation of the Discharge-Care Summary. There are several pieces of information about a request that may influence understanding of the record including when requested, by whom, why, etc. |
|---|
classCode : (x_ActClassCareProvisionEncounter)  Business name: B: Request Type This distinguishes between "referral" requests and specific orders. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Discharge-Care Summary Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Request id This identifies the specific request record (referral or order) that this Discharge-Care Summary is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author3 | 0-1 | Req |
| REPC_MT220001CA.Author  Business name: *a: authored by This identifies the provider who is responsible for the decision to capture the Discharge-Care Summary in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode : "AP" (ContextControl) | 1 | Mand | signatureCode : (ParticipationSignature)  Business name: K:Attested Indicator An indication that the provider attests to the authenticity of the document that he/she has authored. Important for assessing the level of 'officialness' of a document. Because it must always be known whether a document has been attested or not, the attribute is mandatory. | 1 | Mand |
|
| |
| | REPC_MT220001CA.Component3 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "true"  | 1 | Mand | | section : Section | 1 | Mand |
|
| | REPC_MT220001CA.Component5 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
|
| | REPC_MT220001CA.Component7 |
|---|
typeCode : "COMP" (ActRelationshipType) | 1 | Mand | contextControlCode : "ON" (ContextControl) | 1 | Mand | contextConductionInd : "false"  | 1 | Mand | | reference : Reference | 1 | Pop |
|
REPC_MT220001CA.ConditionEvent  Business name: Discharge Diagnoses Describes one of the conditions associated with the patient as part of the encounter. Commonly used for reporting, but also useful for searching and for obtaining a general understanding of the encounter. |
|---|
classCode : "COND" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : CD (ActCode)  Business name: A: Discharge Diagnosis Type Identifications of the type of diagnosis at the time of discharge. For SNOMED, the complete diagnosis appears here. For non-SNOMED this should be a fixed value of "DX". The diagnosis is core information around which the care provision revolves, therefore this is a mandatory attribute. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | value : (DiagnosisValue)  Business name: B:Diagnosis Code Identifies the actual discharge diagnosis. Provides context into the result of the care provision. The attribute is optional because for systems that support SNOMED, this concept will be communicated as part of the Discharge Diagnosis Type | 0-1 | Opt |
| REPC_MT220001CA.Document  Business name: Discharge-Care Summary Represents a particular health-related document pertaining to a single patient. Allows the capture of patient health data in an encapsulated, contextualized manner with capability of displaying rendered content and communication between simple systems. |
|---|
classCode : "DOCCLIN" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (CareSummaryDocumentType)  Business name: B: Document Category Identifies the type of Discharge-Care Summary represented by this record. e.g. referral, consult note, clinical summary. Document Category is used for searching and for organizing Discharge-Care Summary records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. | 1 | Mand | title :  Business name: J: Document Title A human-readable label for this particular document. Titles do not necessarily need to be unique, but should be precise-enough to give a pretty good idea of what the document contains. For example "Right Knee Arthroscopy Report, Jan 3, 2006" would represent a good title. "Surgery Report" would not. This is a human-recognizable name intended to be displayed on the screen in list transactions and is therefore mandatory. It provides a good indication of the content of the document at a quick glance. | 1 | Mand | confidentialityCode : SET<CV> (x_VeryBasicConfidentialityKind)  Business name: E: Document Masking Indicators Communicates the desire of the patient to restrict access to this Discharge-Care Summary 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') 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. The value specified for a particular record may be overridden by a higher level masking applied to an indication, a care composition, a type of record or even all patient records. Allows the patient to have discrete control over access to their health data. Awareness of the patient's desire for confidentiality is important even for providers who have access to the data because it indicates a need for extra caution before disclosing the information to other care providers. Also allows providers to mark records as "not for patient display" for circumstances where the patient has access to their own EHR or where another healthcare provider discusses or provides them with a copy of information from their EHR. (There are some pieces of information where it would be detrimental to a patient's health or ongoing care were they to be aware of those records without careful guidance.) Two repetitions are supported to allow indicating that the record is masked from both a provider and a patient perspective. | 0-2 | Opt | | author : Author | 1 | Mand | | primaryInformationRecipient : InformationRecipient | 0-10 | Req | | predecessor : Predecessor2 | 0-10 | Req | | component : Component2 | 1 | Mand | | subjectOf : Subject4 | 0-1 | Req | | componentOf : Component6 | 0-100 | Req |
|
| |
| REPC_MT220001CA.Location2  Business name: i:occurred at This identifies the location where the actual discharge/care event occurred. E.g. Patient's residence, clinic, work site, hospital, etc. It only needs to be specified when the occurrence location differs from the official record location. The site of the actual event provides context for interpreting the record. In some cases, it may also provide follow-up information The site of the actual event provides context for interpreting the record. In some cases, it may also provide follow-up information |
|---|
typeCode : "LOC" (ParticipationType) | 1 | Mand | contextControlCode : "OP" (ContextControl) | 1 | Mand | | serviceDeliveryLocation : ServiceDeliveryLocation | 1 | Pop |
|
| |
REPC_MT220001CA.PatientCareProvisionEvent  Business name: B: Discharge/Care Summary Report Discrete information about the encounter, episode or other event for which the discharge or care report is being written. Provides contextual overview information for searching and filtering |
|---|
classCode : "ENC" (ActClass)  Need to change classCode to PCPR as soon as encounter is made a specialization and discharge disposition is moved up. | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: M:Reported on Care Composition Link Provides the identifier of the discrete encounter, episode or care event being reported on. Allows for drill-down and for direct association between the report and the discrete record. | 0-1 | Req | code : CD (ActCareEventType)  Business name: C: Discharge/Care Summary Report Type Identifies the type or category Summary Report represented by this record. The discharge / care report summarizes the events and activities that happened during care including who is responsible for the care provided. The report is sent at the termination of care. In this case, the performer is the sending provider. Examples: Inpatient stay, cardiology, etc. Discharge/Care Summary Report Type is used for searching and for organizing Discharge-Care Summary records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. This element makes use of the CD datatype to allow for use of the SNOMED code system that in some circumstances requires the use of post-coordination. Post-coordination is only supported by the CD datatype. | 1 | Mand | statusCode : (x_ActStatusActiveComplete)  Business name: D: Preliminary/Final Indicator This identifies the current state of the Discharge-Care Summary record. If the status is 'active' it means that the assessment is ongoing and the report is preliminary. If the status is 'completed' it means that the assessment is finished and the report is considered complete. Status is frequently used to filter query responses as well as to sort records for presentation. It also affects how the Discharge-Care Summary record is interpreted. Because the status won't always be known, the attribute is marked as 'populated' to allow the use of null flavors. | 1 | Pop | effectiveTime : IVL<TS.DATETIME>  Business name: F: Discharge/Care Summary Report Period Indicates the period of care to which the discharge or care report applies. For an encounter discharge assessment, this would be the admit and discharge date. Identifies the time-period of relevance to the record which is useful in filtering and organizing "time-view" presentations of data. Because the period covered by a discharge or care summary should always be known, this attribute is mandatory. | 1 | Mand | dischargeDispositionCode : (EncounterDischargeDisposition)  Business name: N:Discharge Disposition Indicates the manner in which the patient left the encounter or other care event. E.g. 'Deceased', 'Discharged to home', 'Discharged to isolation' May be important in planning subsequent care for the patient. Something must be said about discharge condition but in some circumstances the value may not be known. Thus the attribute is treated as 'populated'. | 1 | Pop | | location : Location2 | 0-1 | Req | | outcome : Outcome | 0-100 | Req | | inFulfillmentOf : InFulfillmentOf | 0-1 | Req |
| |
| |
| REPC_MT220001CA.Reference |
|---|
classCode : "ACT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | id : II.BUS  Business name: L:Reference Record Links These identifiers allow for referencing other discrete records within the EHR which are considered relevant to the document as a whole or a particular section. For sections, the links may refer specifically to records which have been rendered as part of the section. The external references allow accessing discrete data for additional analysis and manipulation such as graphing, automated comparison or decision-support. | 1 | Mand |
| | REPC_MT220001CA.Section |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | text : ED.DOC  Business name: M: Document Overview Content Provides the primary rendered textual content of the document. E.g. The cover letter for a referral, the overview portion of a report, etc. There is no guidance provided within the standard on how report content should be organized or formatted. Guidance may be provided by professional colleges, specialty groups or others. Represents the principle content of the document and therefore is mandatory. | 1 | Mand | | component1 : Component4 | 1 | Mand | | component2 : Component | 0-100 | Req | | component3 : Component5 | 0-100 | Req |
|
| REPC_MT220001CA.SubSection  Business name: Document Sections Used to document additional relevant information about the patient such as allergies, medications, problem list, etc. Provides contextual information for understanding the Discharge-Care Summary by sharing a filtered, rendered view of portions of the patient's record. |
|---|
classCode : "DOCSECT" (ActClass) | 1 | Mand | moodCode : "EVN" (ActMood) | 1 | Mand | code : (DocumentSectionType)  Business name: A: Section Type Identifies the type of Discharge-Care Summary represented by this record. Examples: allergy list, problem list, medication list, etc. Section Type is used for searching and for organizing Discharge-Care Summary records as well as sorting them for presentation. This is a key attribute for understanding the type of record and is therefore mandatory. The element uses CWE to allow for the capture of Section 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 | title :  Business name: B: Section Title Represents the label associated with this particular portion of the document. These are a human-readable equivalents to the Section Type code. E.g. "Allergies", "Assessment", "Recommendations", etc. Provides a human readable label for the section. Because it is used as part of the document rendering, the attribute is mandatory. | 1 | Mand | text : ED.DOC  Business name: M: Section Content Represents the rendered text content for the section. Provides a human-readable view of data that is accessible without sophisticated PoS applications. Allows data to be filtered and rendered in a manner to focus on the content deemed relevant by the author of the document. Because it coveys the content, the attribute mus be mandatory. | 1 | Mand | | component : Component7 | 0-100 | Req |
|
|
|
|
|
|---|
REPC_MT220002CA.ActRequest  Business name: Request A particular request (referral or specific request) that resulted in the creation of the Discharge-Care Summary. There are several pieces of information about a request that may influence understanding of the record including when requested, by whom, why, etc. |
|---|
classCode : (x_ActClassCareProvisionEncounter)  Business name: B: Request Type This distinguishes between "referral" requests and specific orders. Needed to know what query to execute to retrieve details about the request. (I.e. Get Patient Referral vs. Get Discharge-Care Summary Order.) | 1 | Mand | moodCode : "RQO" (ActMood) | 1 | Mand | id : II.BUS  Business name: A:Request id This identifies the specific request record (referral or order) that this Discharge-Care Summary is fulfilling. The type of request is identified by the Request Type. Associates a request to its results. Allows querying for results associated by a request. Also, authors of requests are generally authorized to view associated results, even if masked. Result records may also be automatically retrieved when retrieving the request record. This attributes is only "required" because in some cases there might not be a formal electronic request. However, the requesting provider may still be known. | 0-1 | Req | | author : Author3 | 0-1 | Req |
| |
REPC_MT220002CA.Author  Business name: *a: authored by This identifies the provider who is responsible for the decision to capture the Discharge-Care Summary in the patient's EHR. Note that while the author is frequently the data-enterer, this will not always be the case, for example where transcribers are involved. Used to identify responsibility for accuracy and relevance of the information. This association reflects primary responsibility, and is therefore mandatory. The author is generally the person to contact with requests for additional information. In some cases, this information may also be used for filtering or sorting. |
|---|
typeCode : "AUT" (ParticipationType) | 1 | Mand | contextControlCode :  |
|