Child pages
  • Performance Framework - Specifications and Schemas

Medbiq_logo_rtm.gif

 

 

 

 

Performance Framework Specifications

 

 

 

 

 

 

 

 

 

Version: 0.1
Date: May 8, 2013
Author: Valerie Smothers
Author email: vsmothers@jhmi.edu

 


Version History

 

Version No.

Date

Changed By

Changes Made

0.1

2013-05-08

 

Initial draft

 

 

 

 


MedBiquitous Consortium XML Public License and Terms of Use

 

MedBiquitous XML (including schemas, specifications, sample documents, Web services description files, and related items) is provided by the copyright holders under the following license. By obtaining, using, and or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.

The Consortium hereby grants a perpetual, non-exclusive, non-transferable, license to copy, use, display, perform, modify, make derivative works of, and develop the MedBiquitous XML for any use and without any fee or royalty, provided that you include the following on ALL copies of the MedBiquitous XML or portions thereof, including modifications, that you make.

  1. Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the following notice should be used: “Copyright © [date of XML release] MedBiquitous Consortium. All Rights Reserved. http://www.medbiq.org”
  2. Notice of any changes or modification to the MedBiquitous XML files.
  3. Notice that any user is bound by the terms of this license and reference to the full text of this license in a location viewable to users of the redistributed or derivative work.

 

In the event that the licensee modifies any part of the MedBiquitous XML, it will not then represent to the public, through any act or omission, that the resulting modification is an official specification of the MedBiquitous Consortium unless and until such modification is officially adopted.

THE CONSORTIUM MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED, WITH RESPECT TO ANY COMPUTER CODE, INCLUDING SCHEMAS, SPECIFICATIONS, SAMPLE DOCUMENTS, WEB SERVICES DESCRIPTION FILES, AND RELATED ITEMS. WITHOUT LIMITING THE FOREGOING, THE CONSORTIUM DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE AND ANY WARRANTY, EXPRESS OR IMPLIED, AGAINST INFRINGEMENT BY THE MEDBIQUITOUS XML OF ANY THIRD PARTY PATENTS, TRADEMARKS, COPYRIGHTS OR OTHER RIGHTS.  THE LICENSEE AGREES THAT ALL COMPUTER CODES OR RELATED ITEMS PROVIDED SHALL BE ACCEPTED BY LICENSEE “AS IS”.  THUS, THE ENTIRE RISK OF NON-PERFORMANCE OF THE MEDBIQUITOUS XML RESTS WITH THE LICENSEE WHO SHALL BEAR ALL COSTS OF ANY SERVICE, REPAIR OR CORRECTION.

IN NO EVENT SHALL THE CONSORTIUM OR ITS MEMBERS BE LIABLE TO THE LICENSEE OR ANY OTHER USER FOR DAMAGES OF ANY NATURE, INCLUDING, WITHOUT LIMITATION, ANY GENERAL, DIRECT, INDIRECT, INCIDENTAL, CONSEQUENTIAL, OR SPECIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF ANY USE OF MEDBIQUITOUS XML. 

LICENSEE SHALL INDEMNIFY THE CONSORTIUM AND EACH OF ITS MEMBERS FROM ANY LOSS, CLAIM, DAMAGE OR LIABILITY (INCLUDING, WITHOUT LIMITATION, PAYMENT OF ATTORNEYS’ FEES AND COURT COSTS) ARISING OUT OF MODIFICATION OR USE OF THE MEDBIQUITOUS XML OR ANY RELATED CONTENT OR MATERIAL BY LICENSEE.

LICENSEE SHALL NOT OBTAIN OR ATTEMPT TO OBTAIN ANY PATENTS, COPYRIGHTS OR OTHER PROPRIETARY RIGHTS WITH RESPECT TO THE MEDBIQUITOUS XML.

THIS LICENSE SHALL TERMINATE AUTOMATICALLY IF LICENSEE VIOLATES ANY OF ITS TERMS AND CONDITIONS.

The name and trademarks of the MedBiquitous Consortium and its members may NOT be used in advertising or publicity pertaining to MedBiquitous XML without specific, prior written permission. Title to copyright in MedBiquitous XML and any associated documentation will at all times remain with the copyright holders.

 

 



1          Acknowledgements

The development of this specification is made possible as part of an accelerated standards development project funded by the Association of American Medical Colleges.

The MedBiquitous Consortium wishes to acknowledge the MedBiquitous Competencies Working Group members, invited experts, and other individuals that contributed to the creation of this document.

Co-chairs:

  • Rosalyn Scott , MD, Department of Veteran's Affairs
  • Tim Willett, MD, SIM-one

Members:

  • Susan Albright, Tufts University
  • Mary Pat Aust, American Association of Critical-Care Nurses
  • Dana Bostrom, Association of American Medical Colleges 
  • Terri Cameron, Association of American Medical Colleges
  • Mary Jo Clark, PhD, RN, American Association of Colleges of Nursing
  • Stephen Clyman, MD, National Board of Medical Examiners
  • Matthew Cownie, University of the West of England
  • Robert Englander, MD, Association of American Medical Colleges
  • Ted Hanss, University of Michigan
  • Sean Hilton, MB BS, St. George's University of London
  • Joshua Jacobs, MD, National University of Singapore
  • PJ Kania, Association of American Medical Colleges
  • David Kiger, Tufts University
  • JB McGee, MD, University of Pittsburgh
  • David Price, MD, American Board of Family Medicine
  • Isarin Sathitruangsak, Tufts University 
  • Lesley Southgate, M.D., St. George's University of London
  • Nabil Zary, PhD, Karolinska Institute

Invited Experts:

  • Connie Bowe, MD, Partners HealthCare International
  • Kelly Caverzagie, MD, University of Nebraska Medical Center
  • Allan Cumming, MD, University of Edinburgh
  • Rachel Ellaway, PhD, Northern Ontario School of Medicine
  • Simon Grant, JISC-CETIS
  • Linda Gwinn, Georgetown University
  • Robyn Herring, University of Mississippi
  • Kevin Krane, MD, Tulane University
  • Steven Lieberman, MD, University of Texas Medical Branch
  • Linda Lewin, MD, University of Maryland
  • Karen Macauley, DNP, PhD, University of San Diego Hahn School of Nursing and Health Science 
  • Chandler Mayfield, University of California, San Francisco
  • Daniel Rehak, PhD
  • Juliane Schneider, Harvard University
  • Eric Warm, MD, University of Cincinnati

Specification authors also received technical guidance from members of the MedBiquitous Technical Steering Committee.

  • Joel Farrell , IBM, Technical Steering Committee Chair
  • James Fiore, American Board of Surgery
  • Steve Kenney, American Osteopathic Association
  • Andrew Rabin, CECity
  • Dan Rehak, Learning Technologies Architect

 

 


2          Documentation Conventions

This document uses the following conventions:

Convention

Description

Bold Text

When used with an XML element name, indicates that the element contains sub-elements.

Italics

When used in an XML element description, an attribute of the XML element.

Monospaced type

Sample XML tags, code, schema, or portion thereof.

 

The document uses graphics generated by Altova XML Spy® software, which uses the following graphical conventions.

 

address-example_schemadiagram.png


3          Conformance

To conform to the MedBiquitous Performance Framework specification, an XML document shall:

 

 


4          Common Data Types

Most of the elements and attributes in MedBiquitous XML documents use the data types defined by the W3C XML schema definition. In some cases MedBiquitous creates its own datatypes as part of its best practices or to meet a specific requirement. Commonly used datatypes are described below.

Non-null string

Non-null string is a datatype derived from the XML string datatype.  Non-null string imposes a minimum length of one character on a string and ensures that required elements are complete.

 


5          Introduction

To be completed

 


6          Other Standards, Specifications, or Schemas Referenced

 

This standard references the following standards, specifications, or schemas. The informative references here, which describe how these references are used, link to formal references appearing later in this document.

 

  • Dublin Core terms

 

  • MedBiquitous Competency Framework [ Competency Framework ]
    Competency Framework provides a way of specifying the hierarchical and non-hierarchical relationships among competencies, learning objectives, learning outcomes, etc.

 

  • MedBiquitous Competency Object [ Competency Object ]
    Competency Object provides a common format for representing competencies, learning objectives, learning outcomes, etc.

 

  • Resource Description Framework

 


7          Schema Grammar

The following sections explain the Performance Framework Schema grammar. Values in bold under XML Tags column indicate that the element has sub-elements.

All the elements having sub-elements will be defined in separate sections. All elements without sub-elements will be defined within the appropriate element sections that use them.

7.1        PerformanceFramework

PerformanceFramework is the root element. It contains subelements that describe one or more sets of performance levels to be used in assessing competence or performance.

performance_framework.png

PerformanceFramework Element Information

Element

Description

Required

Multiplicity

Datatype

PerformanceFramework

PerformanceFramework is the root element. It contains subelements that describe one or more sets of performance levels to be used in assessing competence or performance.

Required

1

Container

lom

Lom contains subelements that define title, publisher, and other descriptive information about this performance framework. 

The lom element is defined in the Healthcare Learning Object Metadata standard defined by MedBiquitous. Please see the Healthcare Learning Object Metadata Specifications and Description document for more information on the sub-elements of lom. For information on which subelements of lom are required or recommended for Performance Frameworks, see section Lom Required and Recommended Elements.

Required

1

Container

For more information, see  [ Healthcare LOM ] and [ LOM ].

EffectiveDate

The date this performance framework becomes or became effective.

Optional

0 or 1

Date

RetiredDate

The date upon which this performance framework was retired.

Optional

0 or 1

Date

Replaces

A related performance framework that is supplanted, displaced, or superseded by the described framework.

Implementers must use a URI to represent the related framework.

Replaces is based on the Dublin Core term replaces. For more information, see [ DCMITerms ].

Optional

0 or more

anyURI

IsReplacedBy

A related performance framework that supplants, displaces, or supersedes the described framework.

Implementers must use a URI to represent the related framework.

IsReplacedBy is based on the Dublin Core term isReplacedBy. For more information, see [ DCMITerms ].

Optional

0 or more

anyURI

SupportingInformation

SupportingInformation contains subelements that include or point to supporting information, such as descriptions of the rationale for developing the framework and its intended use. See section SupportingInformation for more information.

Optional

0 or more

Container

LevelScale

LevelScale contains subelements that define a numeric scale used in this performance framework. See section LevelScale for more information.

Optional

0 or more

Container

Component

Component contains subelements that define a component of this performance framework. See section Component for more information.

Required

1 or more

Container

Elements from other namespaces

PerformanceFramework may include elements from other namespaces provided those elements are namespace qualified.

Optional

0 or more

any

 

Example:

To be written

7.2        Lom Required and recommended Elements

Lom contains subelements that define title, publisher, and other descriptive information about this performance framework. 

lom

The table that follows indicates which elements of healthcare lom are required or recommended for use in the Performance Framework. Note that additional lom elements may be used.


lom Element Usage Information EDIT

Element

Description

Required

Multiplicity

Datatype

lom

lom contains subelements that define title, publisher, and other descriptive information about this performance framework. 

For more information on these elements, see [ LOM ] and [ Healthcare LOM ].

Required

1

Container

For more information on lom and its subelements, see  [ Healthcare LOM ] and [ LOM ].

general

A container for general metadata elements.

Required

1

Container

general:identifier

A container for identifier information.

Required

1 or more

Container

general:identifier:catalog

The cataloging system for the unique identifier. For performance frameworks, the catalog must be URI.

Note that organizations may include a catalog other than URI for use within local systems as long as a URI identifier is present in the XML document.

Required

1

Restricted. See Description for details.

general:identifier:entry

Defines a unique identifier for the performance framework. For performance frameworks, identifiers must be in the form of a URI.

Note that organizations may include an entry other than a URI for use within local systems as long as a URI identifier is present in the XML document.

Required

1

anyURI

general:title

Defines the title for this performance framework in one or more languages.

Required

1

LanguageString

general: description

A short description of the performance framework.

Recommended

0 or more

LanguageString

lifecycle

A container for elements relating to the lifecycle of the framework.

Recommended

0 or 1

Container

lifecycle: status

A container for elements describing the status of the performance framework.

Recommended

0 or 1

Container

lifecycle: status: source

The source of the vocabulary for status.  Use LOMv1.0.

Recommended

0 or 1

Restricted See Description for details.

lifecycle: status: value

The status of the performance framework. Valid values are: draft, final, revised, unavailable.  Use of draft and final values is recommended.

Recommended

0 or 1

Restricted. See Description for details.

lifecycle: contribute

A container for elements the people and organizations that have contributed to the performance framework.

Recommended

0 or 1

Container

lifecycle: contribute: role

A container for elements describing the publisher and other entities involved in the development of this framework. Use the role and entity elements within the lifecycle element to indicate the publisher of the performance framework. Role should have a value of publisher and be paired with an entity describing the publisher.

Recommended

0 or more

Container

lifecycle: contribute: role:source

The source of the vocabulary for role.  When describing the publisher, use LOMv1.0.

Recommended

0 or 1

Restricted. See Description for details.

lifecycle: contribute: role: value

The role being described.  To describe the publisher, value should be publisher.

Recommended

0 or 1

Restricted. See Description for details.

lifecycle: contribute: entity

Use the role and entity elements within the lifecycle element to indicate the publisher of the performance framework.  Entity includes a vcard reference to the publisher and should be paired with a role that has a value of publisher.

Recommended

0 or more

CharacterString in VCARD format. See [ LOM ] for details.

educational

A container element for elements related to the educational aspects of the framework.

Recommended

0 or 1

Container

educational: context

 

A container for elements describing the educational environment for which the performance framework is intended.

Recommended

0 or more

Container

educational: context:source

The source of the vocabulary for educational context.  To use the MedBiquitous vocabulary, use HEALTHCARE_LOMv1.

Recommended

0 or 1

Restricted. See Description for details.

educational:context:value

The educational context for which the framework is intended. Use a term from the following MedBiquitous vocabulary (described in HealthcareLOM):

  • patient education
  • caregiver education
  • primary education
  • secondary education
  • vocational training
  • undergraduate education
  • undergraduate professional education
  • graduate professional education
  • continuing professional development

Recommended

0 or 1

Restricted. See Description for details.

rights

A container element for information on copyright and other restrictions.

Recommended

0 or 1

Container

rights: copyrightAndOtherRestrictions

 

A container for elements indicating whether or not copyright or other restrictions exist on the competency framework.

Recommended

0 or 1

Container

rights: copyrightAndOtherRestrictions:source

The source of the vocabulary used to describe copyright and other restrictions. To use the lom vocabulary, use LOMv1.0.

Recommended

0 or 1

Restricted. See Description for details.

rights: copyrightAndOtherRestrictions:value

Indicates whether or not copyright and other restrictions exist. Valid values are yes and no.

Recommended

0 or 1

Restricted. See Description for details.

rights: description

 

The description element within rights provides a brief description of the copyright or other constraints on the performance framework. The description may include a link to a license.

Recommended

0 or 1

LanguageString

healthcareMetadata

A container element for healthcare related metadata.

Recommended

0 or 1

Container

healthcareMetadata:healthcareEducation

A container element for healthcare education related metadata.

Recommended

0 or 1

Container

healthcareMetadata:healthcareEducation targetAudience

A container element for information  about the target audience for whom this framework is intended.

Recommended

0 or 1

Container

healthcareMetadata: healthcareEducation:targetAudience: profession

 

The health profession for which this performance framework is intended.

Recommended

0 or 1

LanguageString

 

 


7.3        SupportingInformation

SupportingInformation contains subelements that include or point to supporting information, such as descriptions of the rationale for developing the framework and its intended use.

supportinginformation.png

Element

Description

Required

Multiplicity

Datatype

SupportingInformation

SupportingInformation contains subelements that include or point to supporting information, such as descriptions of the rationale for developing the framework and its intended use. See section SupportingInformation for more information.

Optional

0 or more

Container

dcterms:references

A reference to the supporting information.

The performance framework adds the following attributes to dcterms:references.

TO BE DEFINED

 

Either dcterms:references or xhtml:div is required

0 or 1

anyType

For the performance framework, the dcterms:reference element should be empty.

xhtml:div

A div element is a mixed type element referenced from XHTML. The div element can include a mix of text and XHTML tags as specified by the XHTML schema.

Either dcterms:references or xhtml:div is required

0 or 1

Container

For more information, see [ XHTML ].

 

Example:

7.4        LevelScale

LevelScale contains subelements that define a numeric scale used in this performance framework.

levelscale.png

LevelScale Element Information

Element

Description

Required

Multiplicity

Datatype

LevelScale

LevelScale contains subelements that define a numeric scale used in this performance framework.

LevelScale has the following attribute:

id
a unique identifier for this level scale. The identifier must be unique within the scope of this report. Use of the id attribute is required.

Optional

Should this be required?

0 or more

Container

WorstScore

The worst score a learner could receive on this scale.

Required

1

Int

(integer)

BestScore

The best score a learner could receive on this scale.

Required

1

Int

(integer)

 

Example:

7.5        Component

Component contains subelements that define a component of this performance framework. A component may have nested components defined. Each component describes a spectrum of performance levels and related background or descriptive information.

component.png

Component Element Information

Element

Description

Required

Multiplicity

Datatype

Component

Component contains subelements that define a component of this performance framework.

Component has the following attribute:

id
a unique identifier for this component. The identifier must be unique within the scope of this report. Use of the id attribute is required.

Required

1 or more

Container

Title

The title of this component. Often the title mirrors the title of the competency for which the performance levels are detailed.

Required

1

NonNullString

Abbreviation

An abbreviation for the component.

Optional

0 or 1

NonNullString

Competency

Competency contains subelements that reference a competency in a competency framework. See section Competency for more information.

Optional

0 or more

Container

Author

An author of this component of the performance framework.

Optional

0 or more

NonNullString

Reviewer

A reviewer of this component of the performance framework.

Optional

0 or more

NonNullString

Background

Background contains subelements that provide background information on this component.

Optional

0 or 1

Container

Resources

Resources contains subelements that describe suggested resources related to this component.

Optional

0 or 1

Container

References

References contains subelements that describe reference to the literature.

Optional

0 or 1

Container

ComponentReference

The ID of a nested Component.

Add order attribute ?

Either ComponentReference or PerformanceLevelSet is required.

0 or more

IDREF

PerformanceLevelSet

PerfromanceLevelSet contains subelements that define a spectrum of performance levels. See section PerformanceLevelSet for more information.

Either ComponentReference or PerformanceLevelSet is required

0 or 1

Container

 

Example:

 

7.5.1         Competency

 

7.5.2         Background

 

background.png

7.5.3         Resources

 

resources.png

7.5.3.1        Resource

 

 

7.5.4         References

 

references.png

7.5.4.1        Reference

 

7.5.5         PerformanceLevelSet

 

performancelevelset.png

7.5.5.1        PerformanceLevel

 

performancelevel.png

7.5.5.2        Criterion

 

7.5.5.3        Background

 

 


8          Sample XML Document

 

<?xml version="1.0" encoding="UTF-8"?>

< CompetencyFramework xmlns =" http://ns.medbiq.org/competencyframework/v1/ " xmlns:lom =" http://ltsc.ieee.org/xsd/LOM " xmlns:xsi =" http://www.w3.org/2001/XMLSchema-instance " xsi:schemaLocation =" http://ns.medbiq.org/competencyframework/v1/ file:///I:/Valerie&apos;s%20stuff/Xml/competency_framework/competencyframework.xsd ">

< lom:lom />

< Relation >

< CompetencyReference1 >

< Catalog > URI </ Catalog >

< Entry > http://www.example.org/12345 </ Entry >

</ CompetencyReference1 >

< Relationship > broader than </ Relationship >

< CompetencyReference2 >

< Catalog > URI </ Catalog >

< Entry > http://www.example.org/23456 </ Entry >

</ CompetencyReference2 >

</ Relation >

</ CompetencyFramework >

 

 


9          References

 

Competency Object
MedBiquitous Competency Object Specifications and description Document. MedBiquitous Website. http://www.medbiq.org/sites/default/files/CompetencyObjectSpecification.pdf . Accessed June 16, 2011.

DCMI
DCMI Metadata Terms, October 11, 2010. Dublin Core Metadata Initiative Website. http://dublincore.org/documents/2010/10/11/dcmi-terms/ . Accessed May 9, 2013.

Healthcare LOM
ANSI/MEDBIQ LO.10.1-2008, Healthcare Learning Object Metadata, MedBiquitous Website. http://www.medbiq.org/std_specs/standards/index.html#HCLOM . Accessed May 9, 2013.

LOM
"IEEE Standard for Learning Technology-Extensible Markup Language (XML) Schema Definition Language Binding for Learning Object Metadata," IEEE Std 1484.12.3-2005 , vol., no., pp.0_1-46, 2005
doi: 10.1109/IEEESTD.2005.97889
URL:   http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=1532505&isnumber=32693

RDF
RDF Vocabulary Description Language 1.0: RDF Schema. W3C Recommendation 10 February 2004. W3C website. http://www.w3.org/TR/rdf-schema/ . Accessed May 9, 2013.

XHTML
XHTML™ 1.0 The Extensible HyperText Markup Language (Second Edition), A Reformulation of HTML 4 in XML 1. 0. W3C Recommendation 26 January 2000, revised 1 August 2002.  W3C website. http://www.w3.org/TR/2002/REC-xhtml1-20020801 . Accessed September 6, 2011.

XSD
Extensible Markup Language (XML) 1.0 (Fifth Edition) , W3C Website.  26 November 2008 http://www.w3.org/TR/2008/REC-xml-20081126/ . Accessed March 20, 2012.