Professional Documents
Culture Documents
Modelling-Medical Device
Modelling-Medical Device
April 1, 2011
Contents
Detailed Clinical Model (DCM) for Medical Devices ....................... Error! Bookmark not defined.
Authors ...................................................................................... Error! Bookmark not defined.
Change History ........................................................................... Error! Bookmark not defined.
Introduction and Objectives ....................................................... Error! Bookmark not defined.
A. Approach ............................................................................... Error! Bookmark not defined.
3. Analysis Information Model ................................................. Error! Bookmark not defined.
4. Detailed Clinical Models ...................................................... Error! Bookmark not defined.
1. Business/Clinical Use Cases .................................................... Error! Bookmark not defined.
Business Actors ....................................................................... Error! Bookmark not defined.
1.1 Intubate Patient................................................................. Error! Bookmark not defined.
1.2 Manage Patient on Ventilator ............................................ Error! Bookmark not defined.
1.3 Liberate Patient from Ventilator ........................................ Error! Bookmark not defined.
1.4 Transport Post-Operative Patient ...................................... Error! Bookmark not defined.
1.5 Included Technical Use Cases ............................................ Error! Bookmark not defined.
2. Clinical Workflows .................................................................. Error! Bookmark not defined.
2.1 Intubate Patient Workflow ................................................ Error! Bookmark not defined.
2.2 Manage Patient On Ventilator Workflow ........................... Error! Bookmark not defined.
2.3 Liberate Patient from Ventilator, Planned Workflow ......... Error! Bookmark not defined.
2.4 Post-Operative Patient Transport ...................................... Error! Bookmark not defined.
2.5 Referenced Technical Workflows ....................................... Error! Bookmark not defined.
3. Analysis Information Model .................................................... Error! Bookmark not defined.
3.1 Information Analysis .......................................................... Error! Bookmark not defined.
3.2 Medical Devices General Requirements ............................. Error! Bookmark not defined.
3.3 Intubation Clinical Note ..................................................... Error! Bookmark not defined.
3.4 Assessment........................................................................ Error! Bookmark not defined.
4. Detailed Clinical Models ......................................................... Error! Bookmark not defined.
4.1 Medical Device Settings and Configuration ........................ Error! Bookmark not defined.
4.2 Medical Device Measurements .......................................... Error! Bookmark not defined.
4.3 Medical Supplies ................................................................ Error! Bookmark not defined.
5. Data Types ............................................................................. Error! Bookmark not defined.
Annexes ..................................................................................... Error! Bookmark not defined.
Annex A: Clinical Scenarios ...................................................... Error! Bookmark not defined.
Annex B: Sample Endotreacheal Intubation Progress Notes ... Error! Bookmark not defined.
Annex C: Out-of-Scope Requirements ..................................... Error! Bookmark not defined.
Glossary .................................................................................. Error! Bookmark not defined.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |3
Authors
Co-Chairs:
Project Facilitator:
Greg Staudenmaier, US Department of Veterans Affairs,
greg.staudenmaier@va.gov
Modeling Facilitator:
Jay Lyle, JP Systems/US Department of Veterans Affairs,
jay.lyle@jpsys.com
Change History
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |4
In addition to addressing the ballot comments, this ballot includes additional use cases:
Initial version documenting the Domain Analysis for the following use cases:
1. Intubate Patient - Unplanned
2. Manage Patient on Ventilator
3. Liberate Patient from Ventilator, Planned
Note that a limited number of proposed Detailed Clinical Models (DCMs) have been included
in this document for comment. This ballot is intended to solicit input on the analysis
approach used to identify DCMs starting from concrete user/clinician needs documented
using business use cases.
The initial "Draft for Comment" ballot was intended to solicit input from all the
stakeholders in Patient Care, Healthcare Devices, and Patient Safety as the input of other
HL7 members interested in Detailed Clinical Models and their applicability to communicating
requirements between clinicians, application developers, interoperability solution
developers, and other stakeholders involved in improving the efficiency healthcare delivery
and increase patient safety at the same time
The objectives of this project is to use a Domain Analysis Model (DAM) in order to specify
the content of a set of reusable Detailed Clinical Models (DCM), The DCMs and the
associated DAM enable semantic interoperability for medical device measurements across
devices and information system.
A. Approach
The intent of this model is to create and maintain Detailed Clinical Models describing the
information exchanged by medical devices in order to improve support for workflow
automation, documentation, and patient safety. Furthermore, this specification organizes
medical device data from and about medical devices in such a manner that it becomes
reusable in different domain models, standards and technologies, thus supporting
consistency of representation and semantic interoperability.
Clinicians need to be able to stipulate requirements for clinical data in a form that they can
understand, both in order to participate in the requirements definition process and in order
to ensure the quality of the resulting documentation. For a variety of reasons, existing
formalisms for data modeling have proven inadequate to this task. The premise behind a
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |5
DCM is to meet that need. It is clinical in scope, so it represents the knowledge of the
clinician rather than the software developer or data modeler. It specifies with a high degree
of precision the information needed by the clinician. And, as any requirements definition
method must, it captures requirements in a consistent and rigorous formalism in order to
support the development of technical specifications.
This section defines the approach used by our project team to identify DCMs starting from
clinical scenarios and use cases representing clinicians' requirements. The methods used are
in a formative stage of development so theoretical or methodological comments from
readers are specifically invited.
The following diagram illustrates how this specification was derived: starting with a set
of business/clinical use cases, next we derived one high-level workflow per use case, and
finally documented the information require to fulfill the use case. Note that an outcome of
the analysis is to identify those DCMs that are reusable.
It is important to emphasize that the use cases and clinical workflows presented in this
document are included not to comprehensively characterize, far less to specify or codify,
medical practice in a subject area but rather to serve as tools for recognizing information
needs to support the development of system requirements and, eventually, serviceable
information systems. When a reader who is a subject matter expert in a clinical area
covered by this work is aware of a different workflow or manner of practice than what is
presented here leading to a different information requirement, it would be a helpful service
to make the authors aware of it.
The DCM criteria and methodology is the subject of ISO NIWP 13972, approved July 2009;
the methodology for HL7 Domain Analysis is documented in the HL7 Development
Framework (HDF).
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |6
Glossary (Artifact)
The project glossary identifies technical and domain-specific terms that are used throughout
the document without definition.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |7
Note: The clinical workflows described in this specification are intended to provide context
and assist in identifying the information required.
The Analysis Information Mode is an element of Domain Analysis Model (DAM) and it is
intended to capture the business stakeholder's perspective regarding the information
required to support the use cases. The analysis model was developed using the conventions
and best-practices developed by HL7 project teams to capture the information requirements
in terms that are familiar to the business stakeholders.
Note that the information analysis model is reusing a set of data types based on standard
(i.e. HL7 and ISO) abstract data types to bridge the differences between platform-specific
implementations.
A separate section will contain all the DCMs identified or reused by this specification. DCM1
and DCM2 are candidate DCM specifications identified during the requirements analysis
process.
DCM1
This is example candidate Detailed Clinical Model derived from the clinician's interoperability
requirements.
DCM2
This is an example candidate Detailed Clinical Model derived from the clinician's
interoperability requirements.
The following sections describe the use cases that determine the scope of the DCMs
included in this specification.
Business Actors
This section specifies the actors that participate in the business use cases. Note that one
actor may participate in more than use case. For a full description of Actor refer to the
glossary.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |8
he following diagram illustrates how the roles specified as actor definitions are inherited. For
example, an Authorized Intubator is a type of Clinician and thus this role includes the
permissions allowed to generic Clinicians but extends these permissions to include
intubation privileges.
Clinician Patient
AuthorizedIntubator
AuthorizedExtubator
CareTeamMember
RespiratoryTherapist
Transporter Nurse
Physician
Clinician (Actor)
A person permitted to provide clinical care to a patient. This role is assumed by a device
operator. As seen in Figure 1, the Clinician is a generic actor, which includes specializations
AuthorizedExtubatlor, AuthorizedExtubator, and a CareTeamMember.
AuthorizedIntubator (Actor)
A clinician of any title who is permitted to perform an intubation procedure. This role may
be played by a physician, nurse anesthetist (CRNA), or a respiratory therapist. This role is
assigned to clinician who performs the procedure.
This actor is a type of Clinician.
AuthorizedExtubator (Actor)
This actor is a provider with authorization to order extubation. Usually this role is played by
a physician, but may be physician‘s assistant or nurse practitioner or respiratory therapist
(in smaller facilities).
This actor is a type of Clinician.
CareTeamMember (Actor)
A clinician, with or without intubation privileges who participates in the intubation procedure
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
Pag e |9
Nurse (Actor)
A nurse participating in the urgent intubation or other use cases specified in this model.This
actor is a type of CareTeamMember.
Physician (Actor)
A licensed physician participating in the urgent intubation. The physician may be involved if
the patient‘s condition either degrades to a point requiring intervention or improves to the
point of indicating a weaning trial. This actor is a type of CareTeamMember.
RespiratoryTherapist (Actor)
A respiratory therapist participating to the intubation procedure. The respiratory therapist is
responsible for ventilator configuration and settings. This actor is a type of
CareTeamMember.
Transporter (Actor)
Depending on the care setting this could be someone who simply moves the patient from
one location to the other. This actor is a type of CareTeamMember.
Patient (Actor)
While the patient has no responsibilities in the workflow, the patient is an important
participant as the subject of the procedure at the center of this use case. The patient
received the procedure described in the use case.
This section describes the contents of this use case including a use case diagram identifying
the main actors.
The following diagram identifies the roles of the participants to the clinical workflow. Each
'stick figure' represents a type of participant/role.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 10
AuthorizedIntubator
CareTeamMember
(from Business Actors)
(from Business Actors)
perform procedure
participate Process steps detailed here:
Intubate Patient
Intubate Patient
«trace»
Ventilator
Arterial Blood Gas monitor
Pulse Oximeter
Electrocardiograph
Physiological Monitor - high acuity, continuous
Capnometer
X-ray Imaging System
Laryngoscope
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 11
TRIGGER
In response to a deterioration in patient condition, a physician orders intubation (verbally or
in a document) and assembles a team.
PRE-CONDITIONS
Patient was admitted to the location where the devices are used
Pre-medication may have been applied
Respiratory and other type of assessments were performed
Supplies for airway management on hand
Monitoring devices are in use, as needed
POST CONDITIONS
If the use case was completed, then
Patient condition
Endotracheal (ET) tube placement verified and secured
Patient assessed for response to intubation
Ventilator status
Ventilator parameters are set
Equipment alarms are set
EHR documentation
All setup readings and settings in EHR
Ongoing monitoring
Patient observations are sent to EHR on the specified schedule
This section describes the contents of this use case including a use case diagram identifying
the main actors.
The following diagram identifies the roles of the participants to the clinical workflow. Each
'stick figure' represents a type of participant/role.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 12
RespiratoryTherapist Patient
(from Business Actors) (from Business Actors)
perform receive treatment
«include» «include»
TRIGGER
Periodic
Alarm event
PRE-CONDITIONS
Patient on ventilator
POST CONDITIONS
If the use case was completed, then
Patient has been assessed
Ventilator settings have been modified, if necessary, to respond to changes in patient
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 13
condition
Ventilator setting changes have been verified by re-assessment
SOURCES
• Clinical Scenario drafted by Donna DuLong and Catherine Hoang
• Meeting with subject matter experts, 13 July 2010
• Meeting with subject matter experts, 16 July 2010
• Meeting with subject matter experts, 20 July 2010
• Endotracheal Intubation Template from National, provided by Warren Rose RRT, Critical
Program Leader, Tampa, Florida
This section describes the contents of this use case including a use case diagram identifying
the main actors
The following diagram identifies the roles of the participants to the clinical workflow. Each
'stick figure' represents a type of participant/role.
Clinician
AuthorizedExtubator
(from Business Actors)
(from Business Actors)
perform
order
assign device to patient
«include»
Patient «include»
(from Business Actors)
receive treatment «include»
Synchronize Time
Manage Patient on
«include»
Ventilator
(from 1.5.2 Time Synchronization)
(from 1.2 Manage Patient on Ventilator)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 14
The device list is not to influence the scope of the modeling effort at this time; it is a draft
list to be used in system boundary definition at a later stage.
Ventilator
Arterial Blood Gas monitor
Pulse Oximeter
Electrocardiograph
Physiological Monitor - high acuity, continuous
Electronic Health Record (local, partial, or comprehensive)
TRIGGER
The patient‘s condition improves to the point where a authorized clinician decides to
evaluate for weaning and extubation.
Provider order for extubation
Or, Clinician determines that the patient meets protocol requirements for extubation
Or, Clinicians agree that the patient meets protocol requirements for extubation
PRE-CONDITIONS
POST CONDITIONS
The following section describes the steps required to transport a patient who relies on
medical devices for ventilation and/or monitoring of physiological parameters.
The following diagram illustrates the actors involved in the use case.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 15
send patient
move patient
receive patient
Transport Post-Operative
Nurse Patient
Transporter
(from Business Actors)
(from Business Actors)
order transport
is «include»
relocated
«include»
Physician
Associate Device with a
(from Business Actors) Patient at the Point-of-care
Pre-conditions: The patient is connected to devices and may need to continue ventilation
for the duration of the transport and until the patient is transferred to another caregiver's
charge.
The following section describes the technical use cases required to support the business
requirements illustrated by the business use cases.
Technical Actors
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 16
MedicalDevice
NetworkedMedicalDevice
LegacyMedicalDevice
MedicalDevice (Actor)
This actor represents either a modern/networked device or a legacy/stand-alone device. In
some use cases, this aspect is not relevant.
DeviceManager (Actor)
A Device Manager is a software and hardware solution intended to connect medical devices
to specific healthcare information systems. It serves a very important purpose in enabling
interoperability for Legacy Medical Devices in particular.
The Device Manager is particularly important for dealing with Legacy Medical Devices. For
those devices, the Device Manager could provide the association with the patient record, the
device operator, and even correct time stamp issues.
LegacyMedicalDevice (Actor)
This actor represents any legacy medical device that is not capable of accessing the local
area network and relies on a DeviceManager to enable interoperability.
NetworkedMedicalDevice (Actor)
Any medical device capable of connecting to the Network Time Server to synchronize its
clock. This device may communicate using standard or proprietary protocols.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 17
The state machine of a device relative to its assignment to specific patient. This state
machine is important in understanding how the device assignment and configuration affect
the clinical workflow.
This state machine helps to illustrate the patient transfer use case. It specifies several of
the states that devices may be in at any time during the transfer.
break association
The following diagram describes how an assigned device may change its state between
active and inactive.
[disconnect patient]
[connect patient]
Inactive
[configure settings] [configure setting]
patient
not
available
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 18
Free (State)
The device is not assigned and it is set up to default settings.
Assigned (StateMachine)
The device is assigned to a patient.
Active (State)
The patient is attached to the device and working for the patient, sending observations
referencing the patient's identity.
Inactive (State)
The medical device is not active, not connected to the patient it was assigned..
The following section describes the use cases and actors required to assign a patient to a
device.
The following is a graphical illustration of the use case.
MedicalDevice
Clinician
(from Technical Actors)
(from Business Actors)
«include»
Clinician
Authentication
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 19
Note: This use case is a placeholder for future Security use cases dealing with device user
authentication and authorization.
NetworkedMedicalDevice
NetworkTime Server
(from Technical Actors)
(from Technical Actors)
look up current time provide current time
Synchronize Time
The following describes the use case and actors in the case when the medical device is
stand-alone, not capable of reaching a network time server.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 20
LegacyMedicalDevice
DeviceManager
(from Technical Actors)
(from Technical Actors)
Synchronize Time
NetworkTime Server
(from Technical Actors)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 21
For networked devices we expect that the devices should be able to use local servers to
set up its clock automatically and synchronize with the rest of the information systems. This
would ensure that any data produced by the device will be time stamped correctly and
reported to the EHRS. The medical devices would use Simple Network Time Protocol clients
to set their clock correctly and stay in synch when restarting, after a battery is replaced, for
daylight savings.
For legacy devices we need to rely on the Device Manager System to add or correct the
time stamp to any device data. We would also need the Device Manager to be time
synchronized using SNTP . Additionally, any legacy device adapter running on the Device
Manager would have to substitute the correct time stamp. We need to ensure that the
medical device time stamp is not used to specify the parameter or measurements recorded
by the device.
2. Clinical Workflows
The scope of a DCM is delineated by a set of clinical Workflows that fulfill specific needs of
business stakeholders (i.e. clinicians).
Therefore this section specifies the scope of this specification by identifying the use cases
in-scope and the clinical Workflows that are required to fulfill the steps identified in the use
case scenarios.
The information specified in a DCM is required to support the clinical workflow therefore this
section important in setting a boundary to the analysis.
Note: Refer to Annex A: Clinical Scenarios for detailed background on the scenarios used
to develop the use case descriptions and the associated clinical Workflows.
Rationale: The workflows described in this section are intended to illustrate the typical
workflows to describe how medical devices are used to support the needs of clinicians.
They define the context of use for medical devices to enable automation and interoperability
in order to:
Improve efficiency
Improve quality
Accelerate documentation of medical procedures
The clinical workflow included in this document are not intended to provide clinicians
guidance on how to practice medicine but rather to describe to other stakeholders (e.g. IT,
vendors, integrators, clinical engineering). The Business Use Cases in Section 1 and the
Clinical Workflows in Section 2 of the DCM for Medical Devices document are intended to
determine the conventions of clinical practices and to make sure that the rest of the analysis
including information and system interactions.
The following diagram summarizes the Workflows derived from the business/clinical use
cases. Each workflow is further elaborated in individual steps.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 22
Intubate Patient
Manage Patient on
Ventilator
The following section describes the workflow as derived from the Intubate Patient use
case analysis.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 23
«EHR»
12. Order Chest X-Ray Chest X-ray Order,
Image, Interpretation
18. Set alarms conditions and [update information] (from 3.1 Information Analysis)
ranges
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 24
<anonymous> AuthorizedIntubator The steps in this partition are performed by the person who play the
role of "Privileged Intubator" as described in the previous section .
Order To Intubate In response to a deterioration in patient condition, a physician orders
intubation (verbally or in a document) and assembles a team. The
physician specifies the ventilator setting in the respiratory consult.
An arterial blood gas laboratory test may also be order in advance of
the Endotracheal Intubation procedure order.
2. Assemble Is there a checklist for supplies? Are the supplies matching the order
Supplies and the preferences of the individual Privileged Intubator? Is the
Endotracheal Tube the correct size based on order and patient's
previous history with intubation?
3. Connect Connect to appropriate power supply (pneumatic, electric) and to the
ventilator to the oxygen source and set up generic settings.
appropriate power
supply and oxygen
source,
4. Initiate The patient is associated with pulse oximetry monitor and the monitor
Monitoring sends its readings to the information system. In Intensive Care
settings, the vital signs are monitored together.
5. Sedate Patient A verbal or written order from the physician would be required before
sedating a patient.
7. Initiate manual This step is also referred as "pre-oxygenation". The nurse or therapist
ventilation will use a mask and an manual bag to pre-oxygenate the patient. This
activity continues until the mechanical ventilation is initiated.
8. Assess patient This assessment is a respiratory assessment.
(Respiratory)
11. Confirm Methods of confirmation may include one or more of he following:
placement using - CO2 reading confirming expiration
secondary methods - EDD device confirming the presence of carbon dioxide in the breath.
The following section describes the workflow as derived from the Manage Patient use
case analysis.
The following diagram describes the steps required to manage the ventilator settings wile a
patient is intubated.
1. Conduct respiratory
[information updated] «device_data»
assessment
Alarm Status
[yes]
4. Apply suction
EHR-S and Device
Data produced during
Oral care the workflow or used
required during this workflow.
6. Move tube to other side of mouth
[yes]
[no]
7. Confirm tube placement
«EHR»
Respiratory Consult
Order
8. Disposable [no] (from 3.1 Information Analysis)
materials
due for change
10. Provide oral
care
[input information] [yes]
«device_data»
9. Change disposable Pulse Oximetry
materials
(from 3.1 Information Analysis)
12. Verify continuation of order and changes 11. Check
monitors
«device_data»
Vital Signs
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 26
Respiratory RespiratoryTherapist This partition contains the activities performed by respiratory therapist
Therapist who manages the patient who is intubated.
4. Apply suction Suction and wait for patient to recover from suction, stop coughing,
etc.
5. Patient due for Also referred as "airway care"
oral care
12. Verify ... This step includes checking for any changes to the order (e.g. vent
continuation of mode).
order and changes
13. Optimize This activity describes the set of steps required to optimize the
Ventialtor Setting ventilator settings starting with those settings ordered by the ordering
physician.
The following section describes the workflow as derived from the Liberate Patient From
Ventilator use case analysis.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 27
[no]
[yes] 6. Distress?
EHR-S and Device Data
Patient failed, continue ventilation produced during the
[no] workflow or used
during this workflow.
«EHR»
17. Finish documentation [update] Procedure
Documentation
Procedure (from 3.1 Information Analysis)
Completed
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 28
3. Assess patient It may include RSBI and other assessment methods based on best-
for readiness to practices.
wean from
ventilator
5. Set ventilator This is done after the assessment
mode and settings
for trial
8. Prepare patient Suction, position, explain process
9. Check previous Difficult or standard - should be part of initial intubation. In this step
intubation difficulty we check to see if additional clinicians need to be involved for a difficult
intubation.
10. Disconnect The device is disconnected from the patient and device association
from ventilator record is updated automatically.
12. Instruct patient The cough helps remove the tube.
to cough to remove
tube
16. Evaluate On-going assessment
patient
The following section describes the workflow as derived from the Transport use case
analysis.
The following diagram details the steps required to transport a patient across the
enterprise.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 29
Patient in PACU,
connected to devices
«EHR»
Transfer Order
1. Order Patient 15. ICU setup
Transfer (from 3.1 Information Analysis)
2. Get patient history, «EHR»
demographics, Patient Medical History
language
(from 3.1 Information Analysis)
«EHR»
Risk factors
3. Get risk factors
(from 3.1 Information Analysis) 16. Set up
«EHR» Devices
4. Get allergy Allergies
(from 3.1 Information Analysis)
«EHR»
5. Get medications Medication
(from 3.1 Information Analysis) Transfer
«device_config» completed
6. Get IV lines IV Line Information
[transport device
needed] [device will be
replaced at the
destination]
11. Transfer [device is sent
settings to the 12. Send current with the
transport device device settings patient]
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 30
The following section elaborates the technical use cases required to support the overall user
requirements regarding intubation and other clinical needs.
System Roles
The following section details the system roles involved in the technical use cases for this
model.
The Patient-to-device association workflow specifies the interactions between devices and
the information system required to establish that a device is assigned to a specific section
and ensure that the alarms and measurements transmitted by the medical device to the
EHR-S or Nursing Flowsheet where the results are later validated and reviewed by clinicians
before they are added to the patient's medical record.
he following diagram illustrates the systems interacting when a device is assigned to the
patient right at the point-of-care using either from a list drawn from known ADT records
captured by the Device Manager and made available to its devices or by entering the
patient's identifier(s) at the bed side - ideally by reading their wrist band. While other user
entry methods are plausible, a barcode reader avoids the entry errors inherent in typing
identifiers on the device.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 31
1.1 lookUpPatient(lastname)
1.6 deviceObservation(ORU^R01)
1.7 deviceObservation(ORU^R01)
The observation contains a reference to the
Patient Info (.e.g. HL7 Version 2.x PID segment).
(from Technical Actors) (from Technical Actors) (from Technical Actors) (from Technical Actors)
The interactions are more complex for Legacy Medical Devices as they rely more heavily on
Device Manager system and, in extreme cases, on information systems to associate the
observations of medical device with a specific patient record.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 32
1.4 deviceObservations(NCCLS)
1.5 addPatientContext()
1.6 addTimeStamp()
1.7 deviceObservations(ORU^R01)
The following section elaborates how time synchronization would operate for legacy and
networked devices.
The following interaction summarized the simple network time synchronization for those
medical devices able to communicate over the local are network with other systems in the
enterprise.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 33
1.0 send(Request)
1.1 SNTPData()
1.2 updateDeviceTime()
ince legacy devices cannot update their clock using SNTP as seen in Figure 2.5.2.a, the
Device Manager may be used to either add an alternative time stamp to the data reported
by the device or substitute the device timestamp with its own.
As seen below, the Device manager may transform a legacy (e,g. ASTM/NCCLS) or
proprietary message structure to the standard-based specification supported by the
enterprise systems (e.g. Nursing Flowsheet).
In the process, the Device Manager may add the patient context based on the location
where the device is placed or its identity. If the device is associated with a specific bed, the
Device Manager will use the ADT information regarding patient's bed location and upon
receiving the information from the medical device.
1.1 SNTPData()
1.2 AddPatient(ADT_A01)
1.3 deviceObservation(NCCLS)
1.4 addTimeStamp()
1.5 addPatientContext()
1.6 deviceObservation(ORU^R01)
(from Technical Actors) (from Technical Actors) (from Technical Actors) (from Technical Actors)
(from Technical Actors)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 34
This section identifies the information required to support the clinical workflow detailed in
Section 2. The contents of this information model are based on the initial clinical scenarios
and constrained by the business use cases. Note that the analysis is intended to define the
business objects required by the clinical work flows; these are not intended to be
implementable classes but to capture the stakeholder's requirements.
This section identifies the broad categories of information produced or consumed during the
clinical workflows.
The following diagram lists the information object identified during the workflow analysis.
The objects in this diagram identify high-level information exchanged between devices and
information systems.
EHR Data
«EHR»
Device Characteristics
Record «EHR»
Medication
Device Configuration «EHR»
Respiratory Consult Order
«EHR»
«device_data»
Risk factors
Device Observations Operational Device
Settings «EHR»
Patient Medical History «EHR»
«device_data» «device_config» Procedure
Alarm Status Personalized Device Documentation
Settings Shared Objects
«EHR»
«device_data» «device_config» «device,EHR» Allergies «EHR»
Vital Signs IV Line Information Device Association Transfer Order
«EHR»
«device_data» «device_config» «device,lab_result» Chest X-ray Order, Image, «EHR»
Pulse Oximetry Ventilator Parameters ABG Interpretation Flowsheet
ABG (Object)
Arterial Blood Gas results may be produced by devices or tests.
Allergies (Object)
Current patient allergies are relevant to many of the procedures and required when
transferring the patient between care settings.
Flowsheet (Object)
Supplies management in the flowsheet is updated with details about the disposable devices.
Medication (Object)
The current medications including infusion.
This section describes the analysis of medical devices identified during the analysis of the
clinical use cases and the associated clinical Workflows. This section is intended to capture
the specific properties and associations required to describe medical devices.
The classes documented in this section address requirements identified initially by analyzing
the Intubate Patient use case. They also support Liberate Patient from Ventilator.
At a high-level the device used to perform observations and it may be configured.
Device
{abstract}
+ deviceIdentifier: InstanceIdentifier [1..*]
+ type: CodedValue observations DeviceObservations
+ modelNumber: InstanceIdentifier
+ vendorId: Id
+ softwareVersion: Text
+configuration
DeviceConfiguration
DeviceAssignment + mode
+ assignmentTime: PointInTime
+ unassignmentTime: PointInTime
SpecialtyConfiguration
PatientReference
PersonalizedConfiguration
+ id: InstanceIdentifier [1..*]
+ account: InstanceIdentifier [0..1]
+ name: PersonName [0..1]
+ gender: CodedValue [0..1]
+ birthDate: PointInTime [0..1]
The following diagram specifies the relationship between the device, its configuration,
observation, the operator, and verifier of the measurement.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 37
Verification
+alarmReported
+alarmConfiguration + time: PointInTime operatedBy
ReportedAlarmStatus
AlarmEventConfiguration verfiedBy
+ severityCode: CodedValue Clinician
::Alarm ::Alarm
+ eventCode: CodedValue + id: InstanceIdentifier
+ eventCode: CodedValue + name: PersonName
+ userMessage: Text + userMessage: Text
DeviceAssignment + statusCode: CodedValue
+ statusCode: CodedValue
+ assignmentTime: PointInTime Resolution
+ unassignmentTime: PointInTime + date: PointInTime
PatientReference Alarm
{abstract}
+ id: InstanceIdentifier [1..*]
+ account: InstanceIdentifier [0..1] + eventCode: CodedValue
+ name: PersonName [0..1] + userMessage: Text
+ gender: CodedValue [0..1] + statusCode: CodedValue
+ birthDate: PointInTime [0..1]
Alarm (Class)
Abstract based class for both configured and reported alarm information.
Attribute Notes
eventCode CodedValue Reason for alarm
Public
userMessage Text User readable message indicating the reason for the error.
Public
AlarmEventConfiguration (Class)
This class describes the alarm configuration completed by device end-users.
Clinician (Class)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 38
Attribute Notes
id InstanceIdentifier Operator's unique identifier assigned by an organization.
Public
Device (Class)
This class identifies a core set of identifying traits of a generic medical device. It identifies
the relationship to classes of objects including EHR order information (e.g. Respiratory
Consult Order).
Note: This is not intended as an exhaustive list of label and identifying traits. Those
interested in the
RequirementTrace Intubation Use Case
This class and its associations were derived from requirements identified in the Intubation
Use case.
RequirementTrace Use Cases: Intubate, Manage on Ventilator, Liberate
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
Attribute Notes
deviceIdentifier Unique device identifier. Currently this identifier is assigned by a manufacturer,
InstanceIdentifier wholesaler, or provider organization but in the future national regulatory agencies
Public will take a more active role in assigning unique identifiers to medical devices
including supplies/consumable devices.
[1..*]
Reference: US FDA Unique Device Identification project.
type CodedValue This attribute is intended to specify a type of device using a code system.
Public
softwareVersion Text This attribute is used to specify the firmware version used by the device. This
Public information may affect the interoperability capabilities of a device.
DeviceAssignment (AssociationClass)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 39
This association class describes the attributes required to describe the patient-to-device or
device-to-patient association.
Attribute Notes
assignmentTime The date/time when the Device was associated to the Patient
PointInTime
Public
unassignmentTime The date/time when the association between the device and the patient is broken.
PointInTime
Public
DeviceConfiguration (Class)
This class organizes the device configuration options: parameter settings, modes, alarms,
etc.
Attribute Notes
mode Device mode
Public
DeviceMeasurement (Class)
This class is used to describe a generic device observation or parameter. This may be a vital
sign measurement, a glucose value, a ventilator setting, etc.
Attribute Notes
code CodedValue This attribute specifies the code of the observation using a standard code system
Public (e.g. LOINC, 11073).
value PhysicalQuantity This attribute is used to specify the value and including units of measure.
Public
effectiveTime This attribute specifies the date/time when the parameter was measured. This is
PointInTime the time reported by the device.
Public
measurementMethod This attributes specifies the method (e.g. measured or calculated) that was used.
CodedValue This attribute is optional since LOINC provides different codes for measured and
Public calculated parameters.
[0..*]
abnormalFlag The abnormal flag indicating that the observation value if out of range.
CodedValue
Public
[0..1]
bodyPosition CodedValue
Public
[0..1]
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 40
Attribute Notes
bodySite CodedValue The body site where the measurement is taken (e.g. axillary).
Public
[0..1]
correctedEffectiveTime This optional attribute may be added by the Device Manager System if the legacy
PointInTime system is not networked in thus unable to keep its clock synchronized over time.
Public
[0..1]
DeviceObservations (Class)
This class groups the alarms and observations produced by a device.
ParameterConfiguration (Class)
This class is used to describe a generic device parameter. This may be used to express a
ventilator parameter.
Attribute Notes
parameterCode This attribute specifies the name of the configuration parameter using a standard
CodedValue code system.
Public
parameterValue This attribute is used to specify the value and including units of measure.
PhysicalQuantity
Public
effectiveTime This attribute specifies the date/time when the configuration was set.
PointInTime
Public
allowableRange This configuration parameter allows the end user to change the
PhysicalQuantityInterval default/manufacturer's reference range for the parameter.
Public
PatientReference (Class)
This class contains the attributes used typically to associate a patient with a device. Note
that this list of patient identifying traits is not comprehensive and, depending on the
accuracy of the identifiers, some demographic traits are redundant.
Attribute Notes
id InstanceIdentifier Patient Identifier (e.g. Medical Record Number).
Public
[1..*]
account InstanceIdentifier The patient account number is sometimes used in addition to the medical record
Public number.
[0..1]
name PersonName Patient name
Public
[0..1]
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 41
Attribute Notes
gender CodedValue
Public
[0..1]
birthDate PointInTime
Public
[0..1]
PerformanceSpecification (Class)
The performance specification associated with the medical device is intended to be
interpreted by the information system (e.g. nursing flowsheet, EHRS).
The list of attributes is not exhaustive.
Attribute Notes
accuracy As how correct value is? how close we are to truth
CodeValueNullable
Public
[0..1]
precision How well
CodeValueNullable
Public
[0..1]
qualityOfService This refers to the quality of the service. It may be affected by the
CodeValueNullable
Public
[0..1]
PersonalizedConfiguration (Class)
A medical device may be further personalized for a specific patient.
ReferenceRange (Class)
This class captures the various reference supported by devices:
instrumental extreme,
physiological extreme,
normal and
extreme ranges for different categories of patients, etc.
Attribute Notes
normalRange Built-in reference range based on manufacturer-designated normal range.
PhysicalQuantityInterval
Public
instrumentalExtremeRa
nge
PhysicalQuantityInterval
Public
[0..1]
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 42
Attribute Notes
physiologicalExtremeRa
nge
PhysicalQuantityInterval
Public
[0..1]
patientExtremeRange This is range specific to a type of patient.
PhysicalQuantityInterval
Public
[0..1]
ReportedAlarmStatus (Class)
Device alarm and their configuration are very important to the clinicians who use a medical
device. This class describes the information reported when an alarm condition occurs.
Attribute Notes
severityCode CodedValue The severity of the alarm event.
Public
SpecialtyConfiguration (Class)
A medical device may be configured for a specific care setting or specialty.
Verification (AssociationClass)
This association class is intended to capture the date/time when the observation is validated
by a clinician and persisted in the EHR-System.
RequirementTrace Use Case: Intubate Patient - Unplanned
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
Attribute Notes
time PointInTime Date/time when a clinician verified the device observation entered in the
Public information system.
This section details reusable classes describing an intubation procedure clinical note; these
classes were identified during the analysis of the clinical use cases and the associated
clinical Workflows.
This section is based on the sample clinical note application described in Annex B.
The following diagram shows the structure of the Intubation procedure including sample
value sets for coded concepts (e.g. the urgency of the procedure is defined by the
ProcedureUrgencyType).
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 43
EndotrachealIntubationProcedure
+ priorityCode: UrgencyCode +confirmationImaging ChestXRayOrder
+ insertionSite: TubeInsertionSiteCode 0..1
+ procedureDateTime: PointInTime
+ tubePlacementConfirmation: ConfirmationMethodCode [0..*]
+ cormackLehaneScale: CodedValue
+ laryngoscopyAttempts: IntegerNullable
+ intubationConfirmationMethod: ConfirmationMethodCode
+ accesInstrument: Instrumentation [0..1] +complication Complication
+ difficultyOfPlacement: DifficultyCode
+ recommendation: Text *
+ status: CodedValue = 'completed'
+ reintubationIndicator: Boolean
«use»
«use» «use» «use»
«enumeration»
«enumeration» «enumeration»
«enumeration» Instrumentation
ConfirmationMethodCode CormackLehaneScale
«use» UrgencyCode Macintosh
Carbon dioxide Full glottic view «use»
Elective Miller
End-tidal capnography Only posterior glottis seen
Urgent Fiberoptic endoscope
Esophageal Detection Device (EDD) Only epiglottis seen
Emergent Videolaryngoscope
Supra-Sternal Tube-Tip Palpation (SSTTP) Epiglottis not seen Lighted stylet
Retrograde wire
«enumeration» None (blind)
«enumeration»
DifficultyCode LMA
TubeInsertionSiteCode
Routine
Difficult Nasal
Oral
Extremely difficult
The following diagram specifies the information captured in a clinical note for a typical
Endotracheal Intubation Procedures.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 44
Complication (Class)
Complication that may occur as a result of a procedure.
ChestXRayOrder (Class)
A chest X-Ray is ordered to validate the tube placement and it reoccurs every 24 hours.
ConfirmationMethodCode (Enumeration)
Type of method to verify the correct placement of the tube in the patient's airway. This
enumeration provides example code values. Actual implementation will use standardized
terminology based on LOINC and SNOMED-CT.
RequirementTrace Endotracheal Intubation Progress Note, US Department of Veterans Affairs
Attribute Notes
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 45
Attribute Notes
Carbon dioxide
Public
End-tidal capnography
Public
Esophageal Detection
Device (EDD)
Public
Supra-Sternal Tube-Tip Used to validate placement of tube in infants, toddlers and children.
Palpation (SSTTP) (clinicaltrials.gov)
Public
CormackLehaneScale (Enumeration)
Indicates the classification according to the Cormack Lehane Scale.
This is an example value set. Actual implementation will use standardized terminology
provided by LOINC.
RequirementTrace Endotracheal Intubation Progress Note, US Department of Veterans Affairs
Attribute Notes
Full glottic view
Public
DifficultyCode (Enumeration)
The degree of difficulty in placing the endotracheal tube in the patient's airway.
This is an example value set. Actual implementation will use standardized terminology (e.g.
LOINC)
RequirementTrace Endotracheal Intubation Progress Note, US Department of Veterans Affairs
Attribute Notes
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 46
Attribute Notes
Routine
Public
Difficult
Public
Extremely difficult
Public
Instrumentation (Enumeration)
A type of device used to provide access, illumination, and allow observation or manipulation
of body cavities, hollow organs, and canals. (Standard Product Nomenclature)
This is an example value set. Actual implementation will use standardized terminology (e.g.
LOINC)
RequirementTrace Endotracheal Intubation Progress Note, US Department of Veterans Affairs
Attribute Notes
Macintosh
Public
Miller
Public
Videolaryngoscope
Public
Lighted stylet
Public
Retrograde wire
Public
None (blind)
Public
LMA
Public
TubeInsertionSiteCode (Enumeration)
This is an example value set. Actual implementation will use standardized terminology. The
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 47
actual implementation will use a subset of LOINC body site codes to indicate the insertion
site for tube.
RequirementTrace Endotracheal Intubation Progress Note, US Department of Veterans Affairs
Attribute Notes
Nasal
Public
Oral
Public
UrgencyCode (Enumeration)
This is an example value set. Actual implementation will use standardized terminology (e.g.
LOINC)
RequirementTrace Endotracheal Intubation Progress Note, US Department of Veterans Affairs
Attribute Notes
Elective
Public
Urgent
Public
Emergent
Public
3.4 Assessment
This section describes a reusable classes identified during the analysis of the clinical use
cases and the associated clinical Workflows. This section is intended to capture clinician
assessments.
Note to the reviewer: This section is a very early draft and it relies on references to
externally-defined DCMs.
.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 48
RespiratoryAssessment
PhysicalAssessment NeurologicalAssessment
+ respirationPresent: boolean
+ qualityOfRespiration: CodeValueNullable
1..*
This model would reuse
height and weight DCMs ArterialBloodGas::
defined in the DCM Arterial Blood Gas
Informative ballot. Panel
Assessment (Class)
This class represents an abstract, choice of one or more assessment that may be
administered to a patient during intubation.
NeurologicalAssessment (Class)
This class is a placeholder for a neurological assessment. In the case of intubation,
however, the most important type of assessment is a respiratory assessment.
PhysicalAssessment (Class)
A physical assessment to evaluate the condition of a patient is an important element in
determining the need to perform an intubation procedure.
RespiratoryAssessment (Class)
This type of assessment represents a pre-condition for intubation as a start of the case. This
class represents the result of the assessment performed by a clinician.
Attribute Notes
respirationPresent
boolean
Public
qualityOfRespiration
CodeValueNullable
Public
The following section describes candidate DCMs derived from the business use cases and on
the Analysis Information Model. Unlike the classes and associations included in the Analysis
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 49
Information Model, a DCM will provide precise semantics and structure including standard-
based data types.
RequirementTrace Use Case Analysis
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
This section describes a set of reusable DCMs identified during the analysis of the clinical
use cases and the associated clinical Workflows.
This DCM package describes devices intended to provide treatment (e.g. ventilator, infusion
pump) as well as their settings.
Note to reviewers: Please comment both on the content and representation of the DCMs
in this package.
The following diagram identifies some of the devices used provide therapy to patients.
The classes listed here were based on the use cases specified in this document.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 50
configured
1..*
VentilatorSetting
::ParameterConfiguration 3.2 Medical Devices General Requirements::
+ parameterCode: CodedValue ParameterConfiguration
+ parameterValue: PhysicalQuantity
+ effectiveTime: PointInTime + parameterCode: CodedValue
+ allowableRange: PhysicalQuantityInterval + parameterValue: PhysicalQuantity
+ effectiveTime: PointInTime
constraints + allowableRange: PhysicalQuantityInterval
{'parameterCode' is encoded using LOINC}
{Use Cases}
«DCM» «DCM»
«DCM»
PositiveExpiratoryEndPressure FractionInspiredOxygen
TidalVolume
::ParameterConfiguration ::ParameterConfiguration
::ParameterConfiguration
+ parameterCode: CodedValue + parameterCode: CodedValue
+ parameterCode: CodedValue
+ parameterValue: PhysicalQuantity + parameterValue: PhysicalQuantity
+ parameterValue: PhysicalQuantity
+ effectiveTime: PointInTime + effectiveTime: PointInTime
+ effectiveTime: PointInTime
+ allowableRange: PhysicalQuantityInterval + allowableRange: PhysicalQuantityInterval
+ allowableRange: PhysicalQuantityInterval
constraints constraints
constraints
{'parameterCode' is encoded and fixed to '20077-4'} {'parameterCode' is fixed as '19996-8'.}
{'parameterValue' is expressed in "cmH2O"} {'parameterValue' is expressed as a percentage} {'parameterValue' expressed in mL}
::VentilatorSetting ::VentilatorSetting {'parameterCode' is set as '20113-7'}
::VentilatorSetting
{ 'parameterCode' is encoded using LOINC } { 'parameterCode' is encoded using LOINC }
{ Use Cases } { Use Cases } { 'parameterCode' is encoded using LOINC }
{ Use Cases }
«DCM»
PressureSupport «DCM» «DCM»
::ParameterConfiguration RespiratoryRate InspiratoryRate
+ parameterCode: CodedValue ::ParameterConfiguration ::ParameterConfiguration
+ parameterValue: PhysicalQuantity + parameterCode: CodedValue + parameterCode: CodedValue
+ effectiveTime: PointInTime + parameterValue: PhysicalQuantity + parameterValue: PhysicalQuantity
+ allowableRange: PhysicalQuantityInterval + effectiveTime: PointInTime + effectiveTime: PointInTime
+ allowableRange: PhysicalQuantityInterval + allowableRange: PhysicalQuantityInterval
constraints
{'parameterCode' is encoded and fixed to '20079-0'} constraints constraints
{'parameterValue' is expressed in ...} {'parameterValue' is expressed in beats per minute} {'parameterCode' is fixed as '19931-5'}
{Not applicable if ventilator is set to volume control mode} {'parameterCode' is fixed as '19834-1'} {'parameterValue' is expressed in liters per minute}
::VentilatorSetting ::VentilatorSetting ::VentilatorSetting
{ 'parameterCode' is encoded using LOINC } { 'parameterCode' is encoded using LOINC } { 'parameterCode' is encoded using LOINC }
{ Use Cases } { Use Cases } { Use Cases }
«DCM»
InspiratoryTime
Only the constraint
introduced by
constraints InspiratoryTime are visible.
{'parameterCode' is fixed to '19973-7'}
{'parameterValue' is expressed in seconds}
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 51
The following are a set of candidate DCMs intended to specify the ventilator settings
required to support the Intubate Patient Use Case, Manage Patient on Ventilator, and
Liberate Patient from Ventilator.
Note that each parameter applies a different set of constraints to the generic ventilator
setting.
constraints constraints
{'parameterCode' is encoded and fixed to '20079-0'} {'parameterCode' is fixed as '19996-8'.}
{'parameterValue' is expressed in ...} {'parameterValue' is expressed as a percentage}
{Not applicable if ventilator is set to volume control mode} ::VentilatorSetting
::VentilatorSetting { 'parameterCode' is encoded using LOINC }
{ 'parameterCode' is encoded using LOINC } { Use Cases }
{ Use Cases }
VentilatorSetting VentilatorSetting
«DCM» «DCM»
InspiratoryRate PositiveExpiratoryEndPressure
::ParameterConfiguration ::ParameterConfiguration
+ parameterCode: CodedValue + parameterCode: CodedValue
+ parameterValue: PhysicalQuantity + parameterValue: PhysicalQuantity
+ effectiveTime: PointInTime + effectiveTime: PointInTime
+ allowableRange: PhysicalQuantityInterval + allowableRange: PhysicalQuantityInterval
constraints constraints
{'parameterCode' is fixed as '19931-5'} {'parameterCode' is encoded and fixed to '20077-4'}
{'parameterValue' is expressed in liters per minute} {'parameterValue' is expressed in "cmH2O"}
::VentilatorSetting ::VentilatorSetting
{ 'parameterCode' is encoded using LOINC } { 'parameterCode' is encoded using LOINC }
{ Use Cases } { Use Cases }
VentilatorSetting
«DCM»
InspiratoryTime
VentilatorSetting VentilatorSetting
constraints
«DCM» {'parameterCode' is fixed to '19973-7'} «DCM»
RespiratoryRate {'parameterValue' is expressed in seconds} TidalVolume
::ParameterConfiguration ::ParameterConfiguration
+ parameterCode: CodedValue + parameterCode: CodedValue
+ parameterValue: PhysicalQuantity + parameterValue: PhysicalQuantity
+ effectiveTime: PointInTime + effectiveTime: PointInTime
+ allowableRange: PhysicalQuantityInterval + allowableRange: PhysicalQuantityInterval
constraints constraints
{'parameterValue' is expressed in beats per minute} {'parameterValue' expressed in mL}
{'parameterCode' is fixed as '19834-1'} {'parameterCode' is set as '20113-7'}
::VentilatorSetting ::VentilatorSetting
{ 'parameterCode' is encoded using LOINC } { 'parameterCode' is encoded using LOINC }
{ Use Cases } { Use Cases }
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 52
VentilatorSetting (Class)
This class specifies the generic ventilator setting including their identity and value. Note that
in addition to its attributes this class specifies a constraint on code system used to specific
the parameter's name. Typically, in an analysis model this level of detail is sufficient.
Similarly in design or platform-specific models this would constitute a sufficient detail.
The primary code system used to specify code for the parameterCode is LOINC. This class is
the base class for a set of specific DCM candidates..
OCL 'parameterCode' is encoded using LOINC
inv: self.parameterCode.codeSystemName = 'LOINC'
RequirementTrace Use Cases
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
FractionInspiredOxygen (Class)
This class is used to capture the fraction of inspired oxygen (FiO2) reported by a ventilator.
This class inherits the attributes specified in DeviceParameter class and the constraints
added by the VentilatorSetting class.
OCL 'parameterValue' is expressed as a percentage
inv: parameterValue.unit = '%'
OCL 'parameterCode' is fixed as '19996-8'.
inv: self.parameterCode.code= '19996-8'
InspiratoryRate (Class)
This class represents the gas flow peak value setting; its value varies by protocol and
patient. It represents the rate of change of volume per unit of time. This class inherits the
attributes specified in DeviceParameter class and the constraints added by the
VentilatorSetting class.
OCL 'parameterCode' is fixed as '19931-5'
inv: self.parameterCode.code = '19931-5'
OCL 'parameterValue' is expressed in liters per minute
inv: parameterValue.unit = 'l/min'
InspiratoryTime (Class)
The class is used to specify the inspiration setting number of seconds. This class inherits the
attributes specified in DeviceParameter class and the constraints added by the
VentilatorSetting class.
OCL 'parameterCode' is fixed to '19973-7'
inv: self.parameterCode.code = '19973-7'
OCL 'parameterValue' is expressed in seconds
inv: parameterValue.unit = 's'
PositiveExpiratoryEndPressure (Class)
This class is used to specify the details of PEEP. This class inherits the attributes specified
in DeviceParameter class and the constraints added by the VentilatorSetting class.
OCL 'parameterCode' is encoded and fixed to '20077-4'
inv: self.parameterCode.code = '20077-4'
OCL 'parameterValue' is expressed in "cmH2O"
inv: self.parameterValue.unit = 'cmH2O'
PressureSupport (Class)
Pressure Support is not applicable to Assist-Control ventilator mode. This class inherits the
attributes specified in DeviceParameter class and the constraints added by the
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 53
VentilatorSetting class.
OCL 'parameterCode' is encoded and fixed to '20079-0'
inv: self.parameterCode.code =' 20079-0'
OCL 'parameterValue' is expressed in ...
inv: self.parameterValue.unit = '...'
Pre-condition Not applicable if ventilator is set to volume control mode
pre: Ventilator.mode <> 'Control'
RespiratoryRate (Class)
This setting specifies a desired respiratory rate (RR), it may be set as target EtCO2 level in
a closed loop system. This class inherits the attributes specified in DeviceParameter class
and the constraints added by the VentilatorSetting class.
OCL 'parameterValue' is expressed in beats per minute
inv: self.parameterValue.unit = 'min'
OCL 'parameterCode' is fixed as '19834-1'
inv: self.parameterCode.code = '19834-1'
TidalVolume (Class)
The class represent a Tidal Volume (Vt) setting. Its value varies by protocol or patient. This
class inherits the attributes specified in DeviceParameter class and the constraints added by
the VentilatorSetting class.
OCL 'parameterValue' expressed in mL
inv: self.parameterValue.unit = 'l/min'
OCL 'parameterCode' is set as '20113-7'
inv: self.parameterCode.code = '20113-7'
Ventilator (Class)
This class represents the properties of a ventilator and extends the generic Device class.
A medical ventilator is a device designed to provide mechanical ventilation to a patient.
Ventilators are chiefly used in intensive care medicine, home care, and emergency medicine
(as standalone units) and in anesthesia (as a component of an anesthesia machine). In its
simplest form, a ventilator consists of a compressible air reservoir, air and oxygen supplies,
a set of valves and tubes, and a disposable or reusable patient set. The air reservoir is
pneumatically compressed several times a minute to deliver an air/oxygen mixture to the
patient; when overpressure is released, the patient will exhale passively due to the lungs '
elasticity. The oxygen content of the inspired gas can be set from 21 percent (ambient air)
to 100 percent (pure oxygen). Pressure and flow characteristics can be set mechanically or
electronically. Ventilators may also be equipped with monitoring and alarm systems for
patient-related parameters (e.g. pressure and flow) and ventilator function.
RequirementTrace Use Case: Intubate Patient - Unplanned
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
Attribute Notes
modeCode The ventilator mode is a represented as a code. The mode affects required settings
VentilatorModeCode of the ventilator.
Public
PressureControl
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 54
VentilatorModeCode (Enumeration)
This enumeration is a list of the most relevant ventilator modes - applicable to intubation
and other use cases. This list is not exhaustive but representative of relevant values.
Attribute Notes
VolumeControl Assist-Control (AC), a mode of mechanical ventilator operation based on volume
Public control. The choice of mode affects other required settings.
WaveformType (Enumeration)
This enumeration is intended to list the waveform types relevant to setting up a patient
during intubation and managing the patient over time.
Attribute Notes
Rectangular Rectangular waveform
Public
This section describes the information identified as a result of analyzing the clinical use
cases and the associated clinical Workflows in this specification. This section describes a
type of devices used to measure physiological parameters during an intubation procedure,
in order to prepare or wean the patient.
The following diagram is describing candidate DCMs derived from classes identified as a
result of analyzing the information requirements documented in the business use cases.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 55
PhysiologicalMonitor
+ mode PulseOximeter ECGMonitor
1.. +measurementDevice
+measurement 1..* 1 +device 1
PhysiologicalMeasurement +device
::DeviceMeasurement +measurement
1..*
+ code: CodedValue
+ value: PhysicalQuantity ElectroCardiogramWaveform
+ effectiveTime: PointInTime
+ waveformImage: EncapsulatedData
+ measurementMethod: CodedValue [0..*]
+ waveformData: PhysicalQuantity [1..*]
+ abnormalFlag: CodedValue [0..1]
+ effectiveInterval: TimeInterval
+ bodyPosition: CodedValue [0..1]
+ bodySite: CodedValue [0..1]
+ correctedEffectiveTime: PointInTime [0..1]
+measurement
constraints
{Use Case: Intubate Patient - Unplanned}
1..*
«DCM»
«DCM» SaturationOfPeripheralOxygen
BodyTemperatureMeasurement ::DeviceMeasurement
::DeviceMeasurement + code: CodedValue
+ code: CodedValue + value: PhysicalQuantity
+ value: PhysicalQuantity + effectiveTime: PointInTime
+ effectiveTime: PointInTime + measurementMethod: CodedValue [0..*]
+ measurementMethod: CodedValue [0..*] + abnormalFlag: CodedValue [0..1]
+ abnormalFlag: CodedValue [0..1] + bodyPosition: CodedValue [0..1]
+ bodyPosition: CodedValue [0..1] + bodySite: CodedValue [0..1]
+ bodySite: CodedValue [0..1] + correctedEffectiveTime: PointInTime [0..1]
+ correctedEffectiveTime: PointInTime [0..1]
constraints
constraints {'parameterCode' is fixed as' 59408-5'}
{'parameterCode' is encoded in LOINC and fixed as '11289-6'} {'parameterValue' is expressed as a percentage}
{'parameterValue' is expressed in degrees Fahrenheit or Celsius} {'parameterCode' is encoded using LOINC}
::PhysiologicalMeasurement {Use Case: Intubate Patient - Unplanned}
{ Use Case: Intubate Patient - Unplanned }
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 56
The following are a set of candidate DCMs intended to specify the parameters measured by
monitoring devices; these measurements are required to support the requirements specified
in Intubate Patient Use Case, Manage Patient on Ventilator, and Liberate Patient from
Ventilator Use Case.
class 4.2.b: DCMs representing the Body Temperature and SpO2 measurements
PhysiologicalMeasurement DeviceMeasurement
«DCM» «DCM»
BodyTemperatureMeasurement SaturationOfPeripheralOxygen
::DeviceMeasurement ::DeviceMeasurement
+ code: CodedValue + code: CodedValue
+ value: PhysicalQuantity + value: PhysicalQuantity
+ effectiveTime: PointInTime + effectiveTime: PointInTime
+ measurementMethod: CodedValue [0..*] + measurementMethod: CodedValue [0..*]
+ abnormalFlag: CodedValue [0..1] + abnormalFlag: CodedValue [0..1]
+ bodyPosition: CodedValue [0..1] + bodyPosition: CodedValue [0..1]
+ bodySite: CodedValue [0..1] + bodySite: CodedValue [0..1]
+ correctedEffectiveTime: PointInTime [0..1] + correctedEffectiveTime: PointInTime [0..1]
constraints constraints
{'parameterCode' is encoded in LOINC and fixed as '11289-6'} {'parameterCode' is fixed as' 59408-5'}
{'parameterValue' is expressed in degrees Fahrenheit or Celsius} {'parameterValue' is expressed as a percentage}
::PhysiologicalMeasurement {'parameterCode' is encoded using LOINC}
{ Use Case: Intubate Patient - Unplanned } {Use Case: Intubate Patient - Unplanned}
Figure 4.2.b: DCMs representing the Body Temperature and SpO2 measurements
BodyTemperatureMeasurement (Class)
This class is a candidate DCM and a specialization of VitalSignMeasurement and
DeviceParameter. This candidate DCM is intended to specify the constraints required to
represent the patient's body temperature as measured by a vital sign monitor.
This is a candidate DCM intended to capture the details of collecting and sharing
interoperable data.
OCL 'parameterCode' is encoded in LOINC and fixed as '11289-6'
inv: self.parameterCode.code = '11289-6'
inv: self.parameterCode.codeSystemName = 'LOINC'
OCL 'parameterValue' is expressed in degrees Fahrenheit or Celsius
inv: self.parameterValue.unit = 'C' or self.parameterValue.unit = 'F'
SaturationOfPeripheralOxygen (Class)
Saturation of Peripheral Oxygen - SPO2- measured by a pulse Oximeter. This class inherits
all the attribute and association of DeviceParameter.
This is a candidate DCM for conveying the details of an oximeter result.
OCL 'parameterCode' is fixed as' 59408-5'
inv: self.parameterCode.code = '59408-5'
OCL 'parameterValue' is expressed as a percentage
inv: self.parameterValue.unit = '%'
OCL 'parameterCode' is encoded using LOINC
inv: self.parameterCode.codeSystemName = 'LOINC'
RequirementTrace Use Case: Intubate Patient - Unplanned
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
ElectroCardiogramWaveform (Class)
This class is intended to specify an electrocardiogram. This version of this class intended to
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 57
Attribute Notes
waveformImage This attribute represents the ECG strip as an image.
EncapsulatedData
Public
[1..*]
effectiveInterval This attribute specifies the start and end of the waveform snippet.
TimeInterval
Public
MonitoringDevice (Class)
This class is intended to capture the properties of monitoring devices and extends the
generic medical device class.
PhysiologicalMonitor (Class)
This class is used to describe the properties of a vital sign monitor. It is a specialization of
MonitoringDevice class and thus it inherits its attributes.
RequirementTrace Use Case: Intubate Patient - Unplanned
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
Attribute Notes
mode Continuous or spot-check.
Public
PulseOximeter (Class)
This class is intended to capture the properties specific to a pulse Oximeter. It is a
specialization of MonitoringDevice class and thus it inherits its attributes.
RequirementTrace Use Case: Intubate Patient - Unplanned
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
PhysiologicalMeasurement (Class)
This class intended to capture the constraints required to represent vital sign results.
This class inherits the attributes specified in the DeviceParameter class.
RequirementTrace Use Case: Intubate Patient - Unplanned
This class is based primarily on the requirements Use case: Intubate Patient - Unplanned but
it support Manage Patient on Ventilator and Liberate Patient.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 58
This section describes a single candidate DCM identified during the analysis of the clinical
use cases and the associated clinical Workflows. This section describes the consumable
medical devices required by the use cases.
The following diagram specifies a set of proprieties common to all consumable devices and
those that are specific to an Endotracheal Tube.
This diagram also shows some of the representative data types that are used to convey the
semantics of the DCM.
DisposableMedicalDevice
{abstract}
+ lotNumber: InstanceIdentifier [0..1]
+ expirationDate: PointInTime [0..1]
«DCM»
Endotracheal Tube
+ diameter: PhysicalQuantity 5. Data Types::PhysicalQuantity
::DisposableMedicalDevice
+ nullFlavor: NullFlavor [0..1]
+ lotNumber: InstanceIdentifier [0..1]
«use» + value: Real [0..1]
+ expirationDate: PointInTime [0..1]
+ unit: CodedValue [0..1]
::Device
+ deviceIdentifier: InstanceIdentifier [1..*]
+ type: CodedValue
+ modelNumber: InstanceIdentifier
+ vendorId: Id
+ softwareVersion: Text
constraints
{Diameter expressed in millimeters}
{Intubate Use Case}
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 59
Note that the attributes of this class are constrained using OCL and the requirements are
based on the Intubate Use Case.
OCL Diameter expressed in millimeters
inv: self.diameter.unit = 'mm'
RequirementTrace Intubate Use Case
This class is based on requirements specified in the Intubate Use Case.
Attribute Notes
diameter PhysicalQuantity This attribute is used to specify the size of a tube as a physical quantity (a numeric
Public value and a units of measure)
DisposableMedicalDevice (Class)
This class is intended to capture the properties of a consumable medical device. This class
supports additional attributes intended to specify the device and, if applicable, its expiration
date.
Attribute Notes
lotNumber The lot number is used to track a device for quality control purposes.
InstanceIdentifier
Public
[0..1]
expirationDate This attribute is used to specify the expiration date, if applicable.
PointInTime
Public
[0..1]
5. Data Types
The following section specifies a set of reusable data types based on the HL7 Version 3
abstract data types. These data types have been constrained to support the analysis
process required to derive a set of DCMs.
Note: The following is a technical specification, it supports the modeling effort but is not
required to understand the high-level information requirements.
Address (Class)
A physical address at which the person resides or may be contacted.
Attribute Notes
addressType Indicates the kind of address that is contained within this class. Examples include
AddressType primaryHome, Work, etc. Note that in HL7 V3, this concept is part of the Address
Public data type (the "use code"). This concept is made explicit in this Address class,
because this is a platform-independent model - non V3 implementations will need
other mechanisms to deal with the type.
effectiveDateRange int The time period for which the address is a valid location for the person or
Public organization. The data type is a TimeInterval, which includes both a start date and
end date, either of which may be empty.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 60
Attribute Notes
line1 String The first line of a mailing address. Unlike HL7, we have chosen not to break up the
Public parts of each line.
[0..1]
line2 String The second line of a mailing address. Unlike HL7, we have chosen not to break up
Public the parts of each line.
[0..1]
line3 String The third line of a mailing address. Unlike HL7, we have chosen not to break up the
Public parts of each line.
[0..1]
city String An Address Part (ADXP) that contains the name of the city, town, village, or other
Public community or delivery center.
[0..1]
county County A region created by territorial division for the purpose of local government. In the
Public United States, a county (or parish in Louisiana) is the largest administrative district
within a state. This property is used primarily for statistical and pricing information
(i.e., the same service may be more expensive in an affluent section of the country
than in a less-affluent portion).
postalCode String An Address Part (ADXP) that contains a postal code designating a region defined by
Public the postal service.
[0..1]
country CodedValue An Address Part (ADXP) that contains the Country of the address.
Public
[0..1]
AddressType (Enumeration)
This enumeration describes types of Addresses at which a person or organization exists or
can be reached.
Attribute Notes
mobileContact A telecommunication device that moves and stays with its owner. May have
AddressType characteristics of all other use codes, suitable
Public
for urgent matters, not the first choice for routine business.
pager AddressType A paging device suitable to solicit a callback or to leave a very short message.
Public
temporaryAddress Thetemporaryaddresswhereapersonresides.Anaddressthatisdifferentfromtheperman
AddressType entaddress,butatwhichthepersonisresidingforalimited,definedperiodoftime.
Public
Note that for military personnel, this address may represent a location at which the
person is temporarily assigned or
deployed.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 61
Attribute Notes
vacationHome A vacation home, to reach a person while on vacation
AddressType
Public
workPlace AddressType An office address. First choice for business related contacts during business hours.
Public
Any (Class)
This abstract class is used to represent a data type that is not known at the logical model
level, but rather will be substituted with a (set of) real data type(s) when transformed to a
given platform.
BirthAddress (Class)
A refinement of AD that contains only a city,state,and country,all of which are optional.
Attribute Notes
city String An Address Part (ADXP) that contains the name of the city, town, village, or other
Public community or delivery center.
[0..1]
state String An Address Part (ADXP) that contains a sub-unit of a state or province. A sub-unit
Public of a country with limited sovereignty in a federally organized country.
[0..1]
country CodedValue An Address Part (ADXP) that contains the Country of the address.
Public
[0..1]
Boolean (Class)
This data type specifies a boolean that may be null and a reason for the null value is
specified as a NullFlavor.
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
Abstract Data types)
[0..1]
CodeValueNullable (Class)
This data type specifies a coded value that may be null and the reason for the null code is
specified as a NullFlavor.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 62
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
Abstract Data types)
CodedValue (Class)
Code class was created to support the generic coded attributes (e.g coded descriptors).
Attribute Notes
code String The plain code symbol defined by the code system. For example, "784.0" is the
Public code symbol of the ICD-9 code "784.0" for headache.
codeSystem OID Specifies the code system that defines the code.
Public
codeSystemVersion
String
Public
displayName String name or title for the code, under which the sending system shows the code value to
Public its users.
County (Class)
Indicates a county or parish within a State of the United States of America. This class is not
to be used for non-US locations.
Attribute Notes
county CodedValue Indicates a county or parish within a State of the United States of America.
Public
EncapsulatedData (Class)
Data that is primarily intended for human interpretation or for further machine processing
outside the scope of HL7. This includes unformatted or formatted written language,
multimedia data, or structured information in as defined by a different standard (e.g., XML-
signatures.) Instead of the data itself, an ED may contain only a reference (see TEL.) Note
that ST is a specialization of the ED where the mediaType is fixed to text/plain.
Attribute Notes
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 63
Attribute Notes
mediaType CodedValue Identifies the type of the encapsulated data and identifies a method to interpret or
Public render the data.
Id (Class)
Generic Identifier Class
Attribute Notes
root OID A unique identifier that guarantees the global uniqueness of the instance identifier.
Public The root alone may be the entire instance identifier. This string should be one of
the following RUID, OID or UUID
InstanceIdentifier (Class)
This data type is a constraint of the HL7 Version 3 II data type.
Attribute Notes
assigningAuthorityNam A human readable name or mnemonic for the assigning authority. The Assigning
e String Authority Name has no computational value. The purpose of a Assigning Authority
Public Name is to assist an unaided human interpreter of an II value to interpret the
authority. Note: no automated processing must depend on the assigning authority
[0..1] name to be present in any form.
extension String A character string as a unique identifier within the scope of the identifier root.
Public
[0..1]
IntegerInterval (Class)
An interval of integer numbers stating the minimal and maximal number of repetitions of
the Act.
Attribute Notes
low Integer The minimal number of repetitions of the Act.
Public
[0..1]
IntegerRatio (Class)
A ratio (numerator : denominator) specifying the relative quantities of the Entity playing the
Role in the Entity scooping the Role, used for Roles that represent composition relationships
between the scooping and playing Entities.
Attribute Notes
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 64
Attribute Notes
numerator Integer The quantity that is being divided in the ratio. The default is the integer number 1
Public
denominator Integer The quantity that divides the numerator in the ratio. The default is the integer
Public number 1 (one.) The denominator must not be zero.
Money (Class)
Indicates the monetary amount to be transferred from the debit to the credit account.
Attribute Notes
currency CodedValue Currencies are the units in which monetary amounts are denominated in different
Public economic regions.
NonUsMailingAddress (Class)
This data type extends the Address to specify a jurisdiction.
Attribute Notes
jurisdiction String
Public
NullFlavor (Enumeration)
This enumeration specifies the null flavors specified for HL7 Version 3 data types.
Attribute Notes
NI NullFlavor No Information, this is the default null flavor/reason.
Public
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 65
Attribute Notes
UNC NullFlavor Unencoded
Public
PersonName (Class)
The name of the person. Uses the VHIM-constrained Person Name data type.
Attribute Notes
prefix String "A prefix has a strong association to the immediately following name part. A prefix
Public has no implicit trailing white space (it has implicit leading white space though).
Note that prefixes can be inverted" (HL7)
[0..*] A Person Name Prefix is usually an academic or nobility title. An Academic title
includes a prefix like "Dr." There are still people with nobility titles (aristocrats).
German "von" is generally a nobility title, not a mere voorvoegsel. Others are "Earl
of" or "His Majesty King of..." etc. Rarely used nowadays, but some systems do
keep track of this.
given String "Given name (don't call it "first name" since this given names do not always come
Public first)" (HL7)
[0..*]
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 66
Attribute Notes
nickname String "A callme name is (usually a given name) that is preferred when a person is directly
Public addressed." (HL7)
[0..1]
family String "Family name, this is the name that links to the genealogy" (HL7)
Public
suffix String "A suffix has a strong association to the immediately preceding name part. A prefix
Public has no implicit leading white space (it has implicit trailing white space though).
Suffices can not be inverted" (HL7)
[0..*]
initials String
Public
[0..1]
PhysicalQuantity (Class)
The amount that was or is to be supplied
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
Abstract Data types)
[0..1]
unit CodedValue The unit of measure specified in the Unified Code for Units of Measure (UCUM)
Public
[0..1]
PhysicalQuantityInterval (Class)
The amount of the therapeutic agent or other substance given at one administration event.
Attribute Notes
lowValue Real The magnitude of the quantity measured in terms of the unit.
Public
lowUnit CodedValue The unit of measure specified in the Unified Code for Units of Measure (UCUM) [].
Public
highValue Real The magnitude of the quantity measured in terms of the unit.
Public
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 67
Attribute Notes
highUnit CodedValue The unit of measure specified in the Unified Code for Units of Measure (UCUM)
Public
PointInTime (Class)
A quantity specifying a point on the axis of natural time. A point in time is most often
represented as a calendar expression.
Semantically, however, time is independent from calendars and best described by its
relationship to elapsed time (measured as a physical quantity in the dimension of time.) A
point in time plus an elapsed time yields another point in time. Inversely, a point in time
minus another point in time yields an elapsed time.
As nobody knows when time began, a point in time is conceptualized as the amount of time
that has elapsed from some arbitrary zero-point, called an epoch. Because there is no
absolute zero-point on the time axis natural time is a difference-scale quantity, where only
differences are defined but no ratios. (For example, no point in time is - absolutely speaking
- "twice as late" as another point in time.)
Given some arbitrary zero-point, one can express any point in time as an elapsed time
measured from that offset. Such an arbitrary zero-point is called an epoch. This epoch-
offset form is used as a semantic representation here, without implying that any system
would have to implement the TS data type in that way. Systems that do not need to
compute distances between points in time will not need any other representation than a
calendar expression literal
A data type containing date/time information.&nabs; This data type is a placeholder, as
various platforms have differing
built-in date/time data types.&nabs; It is anticipated that this data type will be replaced by
a different data type when
Attribute Notes
literal String For the default Gregorian calendar the calendar expression literals of this
Public specification conform to the constrained ISO 8601 that is defined in ISO 8824
(ASN.1) under clause 32 (generalized time) and to the HL7 version 2 TS data
format.
Range (Class)
This data type is used to specify reference ranges as in interval between two numeric values
(low and high).
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 68
Attribute Notes
Abstract Data types)
[0..1]
high Real High value of the range.
Public
[0..1]
unit CodedValue The unit of measure specified in the Unified Code for Units of Measure (UCUM)
Public
[0..1]
RateQuantity (Class)
Identifies the speed with which the substance is introduced into the subject. Expressed as a
physical (extensive) quantity over elapsed time (e.g., examples are 100 mL/h, 1 g/d, 40
mmol/h, etc.)
Attribute Notes
low PhysicalQuantity This is the low limit of the interval.
Public
period TimeQuantity A time duration specifying as a reciprocal measure of the frequency at which the
Public periodic interval repeats.
Ratio (Class)
A quantity constructed as the quotient of a numerator quantity divided by a denominator
quantity. Common factors in the numerator and denominator are not automatically
cancelled out. The RTO data type supports titers (e.g., "1:128") and other quantities
produced by laboratories that truly represent ratios. Ratios are not simply "structured
numerics", particularly blood pressure measurements (e.g. "120/60") are not ratios. In
many cases the REAL should be used instead of the RTO.
Ratios are different from rational numbers, i.e., in ratios common factors in the numerator
and denominator never cancel out. A ratio of two real or integer numbers is not
automatically reduced to a real number.
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
Abstract Data types)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 69
Attribute Notes
numerator Real The quantity that is being divided in the ratio. The default is the integer number 1
Public (one.)
denominator Real The quantity that divides the numerator in the ratio. The default is the integer
Public number 1 (one.) The denominator must not be zero.
Real (Class)
A data type containing non-whole numbers. This data type is a placeholder, as various
platforms have differing built-in floating-point data types. It is anticipated that this data
type will be replaced by a different data type when transforming to a particular
implementation platform.
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
Abstract Data types)
[0..1]
Telecommunications (Class)
A collection of electronic addresses at which the person may be reached. This includes
telephones, email addresses, etc.
Attribute Notes
addressType Indicates the kind of communications address that is contained within this class.
AddressType Examples include primaryHome, Work, etc. Note that in HL7 V3, this concept is
Public part of the Telecom data type (the "use code"). This concept is made explicit in
this Telecommunications class, because this is a platform-independent model - non
V3 implementations will need other mechanisms to deal with the type.
effectiveDateRange int The time period for which the phone number or communications address is valid for
Public the person or organization. The data type is a TimeInterval, which includes both a
start date and end date, either of which may be empty.
Text (Class)
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 70
Attribute Notes
nullFlavor NullFlavor "An indicator of a data value's exceptional status, sometimes also denoting the
Public manner and rationale for that status.Null values are also known as exceptional
values. This is to denote that the information contained in the value is an exception
[0..1] to the expected value domain that applies to the type. The information may either
be missing or partially present, or even completely present but not valid with
respect to the constraints imposed by the Constraining Model" (HL7 Version 3
Abstract Data types)
[0..1]
TimeInterval (Class)
An interval of time specified as an interval between two date/time (high and low).
Attribute Notes
low PointInTime This is the low limit of the interval.
Public
[0..1]
high PointInTime This is the high limit of the interval.
Public
[0..1]
width TimeQuantity The difference between high and low boundary. The purpose of distinguishing a
Public width property is to handle all cases of incomplete information symmetrically. In
any interval representation only two of the three properties high, low, and width
[0..1] need to be stated and the third can be derived.
TimeQuantity (Class)
A length of time specified as a Physical Quantity, e.g., 5 minutes, 2.5 hours.
Attribute Notes
value Real Value of the number of time units
Public
unit CodedValue The unit of measure specified in the Unified Code for Units of Measure (UCUM).
Public
UsMailingAddress (Class)
A specialization of Address that is used for U.S. addresses. Note that the state attribute
may only contain a code for a U.S. State, territory, or a PO box.
Attribute Notes
state CodedValue An Address Part (ADXP) that contains a sub-unit of a state or province. A sub-unit
Public of a country with limited sovereignty in a federally organized country.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 71
Annexes
This section includes the clinical scenarios developed with the subject matter experts:
http://gforge.hl7.org/gf/download/docmanfileversion/5782/7424/VentilatorClinicalScenario_
_1_rev4.docx
The use cases derived from the detailed scenario are available at:
http://gforge.hl7.org/gf/project/dcmmd/docman/?subdir=256
http://gforge.hl7.org/gf/download/docmanfileversion/5784/7426/EndotrachealIntubation-
ApplicationExample.pptx
This annex identifies future areas of analysis to elaborate the workflows and information
analysis.
A number of views of information models supporting and inter-relating DCM‘s are developed
at appropriate points in the discussion, as characterized in Figure C..
In general, the views support DCM procedural/process content for clinical decision support
(CDS) and supervisory and automatic control and data acquisition (SCADA), observation,
and reporting purposes. The main components/views identified in the figure include [but
are not limited to):
1. an information base/model and DCM-related views of control and observation
variables;
2. an ontology and related [set of] template[s] for specifying ventilator modal behavior;
3. a finite state model (FSM) characterizing selected breath delivery; and
4. and a [set of] model[s] depicting [co-]optimization of key variables related to
ventilation and oxygenation.
In the figure, the relational attributes at the top characterize a virtual “timeline” in which
significant “vectors” can be identified for detailed clinical modeling, initially through the
DCM4MD use case procedural/process diagram and subsequently through relevant views. It
is expected that the set will be highly reusable across DCM’s in this domain and may provide
or be provided information from other DCM’s (for example, ABG).
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 72
Ventilator Modes
changing over time
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 73
Glossary
Term Type Description
Activity and Technical An activity in Unified Modeling Language (UML) is a major task
Activity that must take place in order to fulfill an operation contract.
Diagram Activities can be represented in activity diagrams
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 74
Extubation Business This term is used to describe the removal of a device from a
hollow organ.
FiO2 Business Fraction of inspired oxygen, a percentage of inhaled gas
HL7 Profile Technical An HL7 profile is an unambiguous specification of one or more
HL7 standards that have been analyzed for a particular use case.
It prescribes a set of precise constraints upon one or more
standard HL7 artifacts.
An HL7 profile is conformant, in all aspects, with the HL7 defined
specification used in the profile according to the constraints or
extension rules. It may specify constraints on the standard HL7
definition. An implementation profile fully describes an
interoperability interaction between two or more systems through
the combination of the following:
a) one use case analysis,
b) one or more dynamic definitions, and
c) one or more static definitions.
HL7 Project Technical A project is a work effort that has the following characteristics:
has an objective (statement of what is going to be produced),
will have a finite existence (the end date to be determined by
the resources available and the start date), and
if additional funding is required, it will have a budget
(including resources and funding sources)
will have at least one participant available to contribute and
must have a project leader, if only an interim to get the
project started
will have at least two implementers (unless the project is
intended to support the HL7 infrastructure)
will have an estimated schedule including deliverables and
milestones.
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 76
Includes Technical A relationship between two use cases in which one use case
Relationship 'includes' the behavior. This is indicated where there a specific
business use cases which are used from many other places - for
example updating a train record may be part of many larger
business processes.
Industry Business Depending on the goals of the project this may be as little as a
outreach set of announcements of work going on in HL7 targeted at the
impacted stakeholder communities. For some projects it may
involve scheduling out-of-cycle meetings, scheduling meetings
jointly with other stakeholder organizations or some kind of
―Town Hall‖ meetings similar to those used for the EHR Functional
Requirements DSTU.
Intubation Business Introduction of a tube into a hollow organ to restore or maintain
patency if obstructed. It is differentiated from CATHETERIZATION
in that the insertion of a catheter is usually performed for the
introducing or withdrawing of fluids from the body.
Reference: MeSH
Intubation - Business Endotracheal intubation is a medical procedure in which a tube is
endotracheal placed into the windpipe (trachea), through the mouth or the
nose. In most emergency situations it is placed through the
mouth.
Endotracheal intubation is done to open the airway to give
oxygen, medication, or anesthesia, and to help with breathing. It
may also be done to remove blockages (foreign bodies) from the
airway or to allow the clinician to examine the upper airway.
ISO/IEEE Technical Within this standard nomenclature codes are defined, these give
11073-10101 the possibility to clearly identify objects and attributes in relation
Nomenclature to the so-called OID-Code). The nomenclature is divided in
partitions, to demarcate codes with regards to content and
functional.
Laryngoscope Business Device for viewing larynx & intubation; also called
'Fiberoptic' or 'Glide'.
LOINC Technical Logical Observation Identifiers Names and Codes (LOINC®)
LOINC: A data set of universal identifiers for laboratory and other
clinical observations to facilitate exchange and storage of clinical
results or vital signs for healthcare.
The purpose of LOINC® is to facilitate the exchange and pooling
of clinical results for clinical care, outcomes management, and
research by providing a set of universal codes and names to
identify laboratory and other clinical observations. The
Regenstrief Institute, Inc, an internationally renowned healthcare
and informatics research organization, maintains the LOINC
database and supporting documentation, and the RELMA mapping
program.
loinc.org
Medical Device Business Any instrument, apparatus, implement, machine, appliance,
implant, in vitro reagent or calibrator, software, material or other
similar or related article:
1) intended by the manufacturer to be used, alone or in
combination, for human beings for one or more of the specific
purpose(s) of:
diagnosis, prevention, monitoring, treatment or alleviation of
disease,
diagnosis, monitoring, treatment, alleviation of or
compensation for an injury,
investigation, replacement, modification, or support of the
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 77
Quality Criteria Business A project commitment to a measure of the quality for each step
of the project cycle. It is expected that most projects will use or
possibly adapt boiler-plate quality criteria developed as part of
HL7‘s methodology.
Quality Review Business An evaluation of whether the work products of a step meet the
pre-established quality criteria. At most steps the project team
will self-assess against these criteria and take a vote (not a
ballot) to move ahead to the next step.
Rosetta Technical The Rosetta Terminology Mapping (RTM) ) IHE PCD Profile is
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 78
http://wiki.ihe.net/index.php?title=PCD_Profile_Rosetta_Terminol
ogy_Mapping
References:
ISO/IEEE 11073-10101 Health informatics — Point-of-care
medical device communication — Part 10101: Nomenclature,
First edition, 2004-12-15. ISO and IEEE, 2004.
The ‗Unified Code for Units of Measure‘ (UCUM).
SME Business Subject Matter Expert or Domain Expert: a person with domain
knowledge that represent the users of IT systems and their
business needs.
SNTP Technical Simple Network Transport Protocol
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 79
Java
Apache (open-source)
NTP client connect to the NTP server using a standard-based
protocol - SNTP
UDP implementation of a client for the Network Time Protocol
(NTP) described in RFC 1305 as well as the Simple Network
Time Protocol (SNTP) in RFC-2030.
http://www.docjar.com/docs/api/org/apache/commons/net/n
tp/package-index.html
Network Time Protocol (NTP) timestamp as defined in RFC-
1305 and SNTP (RFC-2030).
.NET
http://www.codeproject.com/KB/datetime/SNTPClient.aspx
SpO2 Business The saturation level of oxygen in hemoglobin; can be determined
by noninvasive method of pulse oximetry.
Stakeholder Business A person or a company that requests a new standard, a technical
correction to an existing standard, or an enhancement.
Substantive Technical A change that requires ballot. The Architectural Review Board
Change (ARB) provides criteria to determine whether or not a change is
substantive.
HL7 Definition of Substantive
The ARB considers that a change to the standard is substantive if
it would cause an interface sender or receiver to have its
interface fail when a newly specified message was received or
attempted to be sent. This is similar to, but more expansive than,
the definition of backwards compatibility. In general, for
backwards compatibility, a message receiver is expected to
receive a new message and be able to ignore added material. On
the other hand, if there is new material that needs to be parsed
in order to process the message given its new definition, the
change is substantial. On the other hand, if a change would
create a backwards compatibility problem (as defined in Chapter
2), it is substantive by definition.
Substantive Technical According to the American National Standards Institute (ANSI) a
Change (re:HL7 substantive change is one that directly and materially affects the
Ballot) use of the standard. The ANSI definition includes changes that
would break solutions that were implemented using the
specification as it existed before the change. It is important to
note that, as an ANSI Standards Development Organization
(SDO), HL7 SHALL be guided by the ANSI definition. Another way
to express this concept is to note that substantive changes are
those which modify the standard by adding or removing
capabilities. In addition any change that changes the meaning of
the message – whether by adding, subtracting or modifying
content - is a substantive change. A change that materially
affects the content of exchanged messages is substantive. For
example, the addition of a new Trigger Event is substantive;
adding attributes to an existing Message Type is Substantive. On
the other hand, the correction of a typographical error, or the
addition of an example message is not substantive.
When the ARB considers the matter of substantiveness, it
generally uses the following test: a proposed change to the
standard is treated as substantive if an interface would fail when
a message is built, sent or received. This approach is similar to,
but more expansive than, the definition of backwards
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011
P a g e | 80
Nursing Interventions
Reference: MeSH/A0132038
Classification/A10934189 Assisting the patient to breathe
without the aid of a mechanical ventilator
Vt Business Tidal volume; the volume of air inhaled and exhaled in mL
WNL Business Within normal limits
HL7 Version 3 Domain Analysis Model: Detailed Clinical Models for Medical Devices, Release 1
© 2011 – Health Level Seven International. All rights reserved. Informative Ballot, May 2011