Difference between revisions of "PHARM Templates Implementationguide"

From HL7 IPS
Jump to: navigation, search
(Audience)
(Appendix)
Line 75: Line 75:
 
==Validation artifacts (xsd, schematrons) ==
 
==Validation artifacts (xsd, schematrons) ==
  
==Links to platforms, binaries, software libraries ==
 
==Operational information (helpdesk, actual server endpoints for testing/production/validation) ==
 
==FAQ’s ==
 
 
==References / Literature ==
 
==References / Literature ==
  

Revision as of 07:15, 8 June 2017

Document Information

This document contains: Implementation Guide Pharmacy Templates (0.10). The text materials belong to category cdapharm.



Important Notes

HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license, please visit http://www.HL7.org/implement/standards/index.cfm.

If you are the individual that obtained the license for this HL7 Standard, specification or other freely licensed work (in each and every instance "Specified Material"), the following describes the permitted uses of the Material.

A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part without paying license fees to HL7.

INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS wishing to incorporate additional items of Special Material in whole or part, into products and services, or to enjoy additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS as noted below, must become ORGANIZATIONAL MEMBERS of HL7.

B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are authorized, without additional charge, on a perpetual (except as provided for in the full license terms governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal purposes only) and share this Material with your employees and consultants for study purposes, and (b) utilize the Material for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual property rights of third parties (which may include members of HL7). No other license, sublicense, or other rights of any kind are granted under this Agreement.

C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are authorized, without additional charge, to read and use the Specified Material for evaluating whether to implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part. NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7. Please see http://www.HL7.org/legal/ippolicy.cfm for the full license terms governing the Material.

Ownership. Licensee agrees and acknowledges that HL7 owns all right, title, and interest, in and to the Materials. Licensee shall take no action contrary to, or inconsistent with, the foregoing.

Licensee agrees and acknowledges that HL7 may not own all right, title, and interest, in and to the Materials and that the Materials may contain and/or reference intellectual property owned by third parties (“Third Party IP”). Acceptance of these License Terms does not grant Licensee any rights with respect to Third Party IP. Licensee alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize Third Party IP in connection with the Materials or otherwise. Any actions, claims or suits brought by a third party resulting from a breach of any Third Party IP right by the Licensee remains the Licensee’s liability.

Following is a non-exhaustive list of third-party terminologies that may require a separate license:

TerminologyOwner/Contact
Current Procedures Terminology (CPT) code setAmerican Medical Association https://www.ama-assn.org/practice-management/cpt-licensing
SNOMED CT©SNOMED CT® International http://www.snomed.org/snomed-ct/get-snomed-ct or info@ihtsdo.org
Logical Observation Identifiers Names & Codes (LOINC©)Regenstrief Institute, Inc.
International Classification of Diseases (ICD) codesWorld Health Organization (WHO)
NUCC Health Care Provider Taxonomy code setAmerican Medical Association. Please see www.nucc.org. AMA licensing contact: 312-464-5022 (AMA IP services)

Obtaining a CPT Sublicense from HL7

Contact hq@hl7.org about how to obtain a sublicense from HL7 for non-production use of CPT for (i) the development and publication of value sets, profiles, and other artifacts as part of the HL7 Implementation Guides, (ii) as part of defined VSAC value sets, and (iii) to support HL7's terminology services within the Territory.

Flow Down Clauses for CPT Sublicense from HL7

CPT content is copyrighted by the American Medical Association and CPT is a registered trademark of the AMA.

HL7, as a party to a license agreement with the AMA, is authorized to grant user a limited, non-exclusive, non-transferable, non-sublicensable license for user to use CPT content for (i) the development and publication of value sets, profiles, and other artifacts as part of the HL7 Implementation Guides, (ii) as part of defined VSAC value sets, and (iii) to support HL7's terminology services within the Territory, each of which shall be considered a non-production use. The sublicense granted hereunder shall automatically terminate upon termination of the agreement between HL7 and AMA, unless prior written consent of AMA is obtained.

The provision of updated CPT content is dependent on a continuing contractual relationship between HL7 and the AMA.

User acknowledge a separate license agreement shall be required, and shall govern any proposed use, including any distribution of CPT content for any other purposes not expressly permitted under this Agreement, and the terms of such agreement will govern such use (e.g., a separate license agreement shall govern production use and commercial purposes). AMA reserves the right to accept or reject licenses based on AMA's evaluation of the proposed use of the CPT content.

User acknowledge that User's development and commercialization of CPT-informed works developed with reference to Licensed Products may only be implemented in the Territory.

User is prohibited from making CPT content publicly available, creating derivative works (including translating), transferring, selling, leasing, licensing, or otherwise making available to any unauthorized party the CPT content, or a copy or portion of CPT content to any unauthorized party, including a subsidiary, affiliate, or other legal entity, however designated, for any purpose whatsoever except as expressly permitted under a separate agreement.

User expressly acknowledges and agrees to the extent permitted by applicable law, use of CPT content is at User's sole risk and CPT content is provided "as is" without warranty of any kind. The AMA does not directly or indirectly practice medicine or dispense medical services. Fee schedules, relative value units, conversion factors and/or related components are not assigned by the AMA, are not part of CPT, and the AMA is not recommending their use. CPT content herein does not replace the AMA's Current Procedural Terminology book or other appropriate coding authority. The coding information contained in CPT content should be used only as a guide.

U.S. Government End Users. CPT is commercial technical data, which was developed exclusively at private expense by the American Medical Association (AMA), 330 North Wabash Avenue, Chicago, Illinois 60611. This agreement does not grant the Federal Government a direct license to use CPT based on FAR 52.227- 14 (Data Rights - General) and DFARS 252.227-7015 (Technical Data - Commercial Items).

User expressly consents to the release of its name to the AMA.

Co-Chair, Primary Editor Melva Peters
Jenaker Consulting
melva@jenakerconsulting.com
Co-Chair, Primary Editor John Hatem
jnhatem@hotmail.com
Co-Chair Scott Robertson PharmD
scott.m.robertson@kp.org
Co-Chair Jean Duteau
jean@duteaudesign.com
Contributor Dr Kai U. Heitmann
Heitmann Consulting and Services, ART-DECOR Open Tools GmbH, HL7 Germany
info@kheitmann.de
Contributor Giorgio Cangioli, PhD
Consultant, HL7 Italy
giorgio.cangioli@gmail.com
Contributor Tom de Jong
VZVZ, HL7 The Netherlands
tom@nova-pro.nl
Contributor Dr Christof Geßner
Gematik GmbH, HL7 Germany
christof.gessner@gematik.de

Introduction

Multiple work groups are developing pharmacy related content. This Implementation Guide is needed to ensure consistency of pharmacy related models across all uses regardless of the method of transport by creating a library of Universal pharmacy templates that can be used by other Work Groups to derive constrained versions.

In addition, this Implementation Guide will review existing pharmacy templates developed by other Work Groups to ensure that they are derivable from the Universal Pharmacy Templates.

Purpose

Background

Scope

Ballot Status of the Document

This Implementation Guide is a Committee Ballot with the intention to go to STU and then to Normative.

Audience

  • Clinical and public health laboratories
  • Immunization Registries
  • Pharmaceutical Vendors
  • EHR/PHR vendors
  • Clinical Decision Support Systems
  • HIS Vendors
  • Emergency Services Providers
  • Healthcare Institutions
  • Pharmacists
  • Physicians and other Clinicians

Relationships with other projects and guides

Principles and background

What is a CDA

Templated CDA

Open and Closed Templates

Template versioning

Identifiers

Terminologies

Datatypes used in this guide

Functional requirements and high-level use cases

Templates

Root Entry Level Templates

Entry Level Templates

Id2.16.840.1.113883.10.21.5Effective Date valid from 2017‑01‑02
StatusKyellow.png DraftVersion Label
NameSubstitutionPermissionDisplay NameUV Substitution Permission
DescriptionInformation about a substitution permission for this adminstration.
ContextParent nodes of template element with id 2.16.840.1.113883.10.21.5
ClassificationCDA Entry Level Template
Open/ClosedOpen (other than defined elements are allowed)
Used by / Uses
Used by 0 transactions and 1 template, Uses 0 templates
Used by as NameVersion
2.16.840.1.113883.10.21.1ContainmentKyellow.png UV Medication Order2015‑10‑07 17:53:30
RelationshipSpecialization: template 2.16.840.1.113883.10.12.300 (2005‑09‑07)
Example
Example
<act classCode="ACT" moodCode="DEF" negationInd="false">
  <templateId root="2.16.840.1.113883.10.21.5"/>  <code code="TE" codeSystem="2.16.840.1.113883.5.1070" displayName="therapeutic alternative"/>  <entryRelationship typeCode="RSON">
    <act classCode="ACT" moodCode="EVN">
      <!-- Reason no substitution -->
    </act>
  </entryRelationship>
</act>
ItemDTCardConfDescriptionLabel
hl7:act
1 … 1M(Substit…
Treetree.png@classCode
cs1 … 1FACT
Treetree.png@moodCode
cs1 … 1FDEF
Treetree.png@negationInd
bl0 … 1 Used to convey that the specified type of substitution is not allowed.
Treetree.pnghl7:templateId
II1 … 1M(Substit…
Treeblank.pngTreetree.png@root
uid1 … 1F2.16.840.1.113883.10.21.5
Treetree.pnghl7:code
CE1 … 1The type of substitution that this permission relates to.(Substit…
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.16621 ActSubstanceAdminSubstitutionCode (DYNAMIC)
Treetree.pnghl7:entryRelationship
0 … 1CUsed when substitution is not allowed and may indicate the reason for why substitution is not allowed.(Substit…
Treeblank.pngTreetree.png@typeCode
cs1 … 1FRSON
 Example<entryRelationship typeCode="RSON">
  <code code="PAT" codeSystem="2.16.840.1.113883.5.8" displayName="Patient request">
    <originalText>Patient objects</originalText>  </code>
</entryRelationship>
Treeblank.pngTreetree.pnghl7:act
1 … 1(Substit…
Treeblank.pngTreeblank.pngTreetree.png@classCode
cs1 … 1FACT
Treeblank.pngTreeblank.pngTreetree.png@moodCode
cs1 … 1FEVN
Treeblank.pngTreeblank.pngTreetree.pnghl7:code
CD1 … 1(Substit…
 CONF
The value of @code shall be drawn from value set 2.16.840.1.113883.1.11.19719 SubstanceAdminSubstitutionNotAllowedReason (DYNAMIC)
 Schematron assertroleKred.png error 
 testnot(hl7:entryRelationship[@typeCode='RSON']) or (@negationInd='true') 
 MessageOnly if substitution is not allowed indicate the reason for why substitution is not allowed 

Appendix

Acronyms and abbreviations

Glossary

Licenses (for the artifacts used, for the code systems, etc.)

Integrated examples, links to instances

Validation artifacts (xsd, schematrons)

References / Literature

List of all artifacts used in this guide

System OIDs / IDs

Code systems

CDA Templates (list of)

Value Sets

Summary tables

Examples (in progress)