org.openhealthtools.mdht.uml.cda.consol.Comment Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2011, 2012 Sean Muir and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Sean Muir (JKM Software) - initial API and implementation
*******************************************************************************/
package org.openhealthtools.mdht.uml.cda.consol;
import java.util.Map;
import org.eclipse.emf.common.util.DiagnosticChain;
import org.openhealthtools.mdht.uml.cda.Act;
/**
*
* A representation of the model object 'Comment'.
*
*
*
* Used to contain comments associated with any of the data within the document.
* This entry allows for a comment to be supplied with each entry. For CDA this structure is usually included in the target act using the <entryRelationship> element defined in the CDA Schema, but can also be used in the <component> element when the comment appears within an <organizer>.
*
* Any condition or allergy may be the subject of a comment.
* This module contains a comment to be supplied for any other entry Content Modules.
*
*
*
* @see org.openhealthtools.mdht.uml.cda.consol.ConsolPackage#getComment()
* @model annotation="http://www.openhealthtools.org/mdht/uml/cda/annotation statusCode.code='completed' code.codeSystem='2.16.840.1.113883.6.1' templateId.root='2.16.840.1.113883.10.20.22.4.64' code.displayName='Annotation comment' constraints.validation.error='CommentTemplateId CommentHasTextReference CommentEffectiveTimeWhenAuthorPresent CommentHasAuthorId CommentHasAuthorOrganization CommentClassCode CommentMoodCode CommentCode CommentText CommentStatusCode CommentAuthor' code.codeSystemName='LOINC' classCode='ACT' code.code='48767-8' moodCode='EVN'"
* @generated
*/
public interface Comment extends Act {
/**
*
*
*
* not self.text.reference.oclIsUndefined()
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='not self.text.reference.oclIsUndefined()'"
* @generated
*/
boolean validateCommentHasTextReference(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* not self.author->isEmpty() implies not self.effectiveTime.oclIsUndefined()
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='not self.author->isEmpty() implies not self.effectiveTime.oclIsUndefined()'"
* @generated
*/
boolean validateCommentEffectiveTimeWhenAuthorPresent(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* not self.author->isEmpty() implies ( self.author.assignedAuthor.id ->size() > 0 and self.author.assignedAuthor.addr ->size() > 0 and self.author.assignedAuthor.telecom ->size() > 0)
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='not self.author->isEmpty() implies ( self.author.assignedAuthor.id ->size() > 0 and self.author.assignedAuthor.addr ->size() > 0 and self.author.assignedAuthor.telecom ->size() > 0)'"
* @generated
*/
boolean validateCommentHasAuthorId(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* not self.author->isEmpty() implies ( self.author->exists( a : cda::Author | ( (not a.assignedAuthor.assignedPerson.oclIsUndefined()) and not a.assignedAuthor.assignedPerson.name->isEmpty()) or (not a.assignedAuthor.representedOrganization.name->isEmpty()) ) )
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='not self.author->isEmpty() implies ( self.author->exists( a : cda::Author | ( (not a.assignedAuthor.assignedPerson.oclIsUndefined()) and not a.assignedAuthor.assignedPerson.name->isEmpty()) or (not a.assignedAuthor.representedOrganization.name->isEmpty()) ) )'"
* @generated
*/
boolean validateCommentHasAuthorOrganization(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.templateId->exists(id : datatypes::II | id.root = '2.16.840.1.113883.10.20.22.4.64')
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.templateId->exists(id : datatypes::II | id.root = \'2.16.840.1.113883.10.20.22.4.64\')'"
* @generated
*/
boolean validateCommentTemplateId(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.classCode=vocab::x_ActClassDocumentEntryAct::ACT
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.classCode=vocab::x_ActClassDocumentEntryAct::ACT'"
* @generated
*/
boolean validateCommentClassCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.moodCode=vocab::x_DocumentActMood::EVN
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.moodCode=vocab::x_DocumentActMood::EVN'"
* @generated
*/
boolean validateCommentMoodCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* (self.code.oclIsUndefined() or self.code.isNullFlavorUndefined()) implies (not self.code.oclIsUndefined() and self.code.oclIsKindOf(datatypes::CD) and
* let value : datatypes::CD = self.code.oclAsType(datatypes::CD) in (
* value.code = '48767-8' and value.codeSystem = '2.16.840.1.113883.6.1'))
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='(self.code.oclIsUndefined() or self.code.isNullFlavorUndefined()) implies (not self.code.oclIsUndefined() and self.code.oclIsKindOf(datatypes::CD) and \nlet value : datatypes::CD = self.code.oclAsType(datatypes::CD) in (\nvalue.code = \'48767-8\' and value.codeSystem = \'2.16.840.1.113883.6.1\'))'"
* @generated
*/
boolean validateCommentCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* (self.text.oclIsUndefined() or self.text.isNullFlavorUndefined()) implies (not self.text.oclIsUndefined())
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='(self.text.oclIsUndefined() or self.text.isNullFlavorUndefined()) implies (not self.text.oclIsUndefined())'"
* @generated
*/
boolean validateCommentText(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* (self.statusCode.oclIsUndefined() or self.statusCode.isNullFlavorUndefined()) implies (not self.statusCode.oclIsUndefined() and self.statusCode.oclIsKindOf(datatypes::CS) and
* let value : datatypes::CS = self.statusCode.oclAsType(datatypes::CS) in (
* value.code = 'completed'))
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='(self.statusCode.oclIsUndefined() or self.statusCode.isNullFlavorUndefined()) implies (not self.statusCode.oclIsUndefined() and self.statusCode.oclIsKindOf(datatypes::CS) and \nlet value : datatypes::CS = self.statusCode.oclAsType(datatypes::CS) in (\nvalue.code = \'completed\'))'"
* @generated
*/
boolean validateCommentStatusCode(DiagnosticChain diagnostics, Map context);
/**
*
*
*
* self.author->one(author : cda::Author | not author.oclIsUndefined() and author.oclIsKindOf(rim::Participation))
* @param diagnostics The chain of diagnostics to which problems are to be appended.
* @param context The cache of context-specific information.
*
* @model annotation="http://www.eclipse.org/uml2/1.1.0/GenModel body='self.author->one(author : cda::Author | not author.oclIsUndefined() and author.oclIsKindOf(rim::Participation))'"
* @generated
*/
boolean validateCommentAuthor(DiagnosticChain diagnostics, Map context);
/**
*
*
* @generated
*/
public Comment init();
} // Comment