org.openehr.rm.composition
Class Composition

java.lang.Object
  org.openehr.rm.RMObject
      org.openehr.rm.common.archetyped.Locatable
          org.openehr.rm.composition.Composition

All Implemented Interfaces:

java.io.Serializable

public final class Composition
extends Locatable

A composition is considered the unit of modification of the record, the unit of transmission in record extracts, and the unit of attestation by authorising clinicians. In this latter sense, it may be considered equivalent to a signed document.

Instances of this class are immutable.

Version:

1.0

Author:

Rong Chen

See Also:

Serialized Form

Constructor Summary

Composition(ObjectID uid, java.lang.String archetypeNodeId, DvText name, Archetyped archetypeDetails, FeederAudit feederAudit, java.util.Set<Link> links, java.util.List<Section> content, EventContext context, DvCodedText category, CodePhrase territory, TerminologyService terminologyService)
Constructs a Locatable

Method Summary

DvCodedText	getCategory() Indicates what broad category this Composition is belogs to, eg "persistent" - of longitudinal validity, "event", "process" etc
java.util.List<Section>	getContent() The clinical session content of this Composition, ie the information generated in the clinical session.
EventContext	getContext() The clinical session context of this Composition, ie the contextual attributes of the clinical session.
CodePhrase	getTerritory() Name of territory in which this Composition was written.
boolean	isPersistent() True if category is a "persistent" type, False otherwise.
Locatable	itemAtPath(java.lang.String path) The item at a path that is relative to this item.
java.lang.String	pathOfItem(Locatable item) String The path to an item relative to the root of this archetyped structure.
boolean	validPath(java.lang.String path) Return true if the path is valid with respect to the current item.

Methods inherited from class org.openehr.rm.common.archetyped.Locatable

concept, getArchetypeDetails, getArchetypeNodeId, getFeederAudit, getLinks, getName, getUid, isArchetypeRoot, setArchetypeDetails, setArchetypeNodeId, setFeederAudit, setLinks, setName, setUid, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Composition

public Composition(ObjectID uid,
                   java.lang.String archetypeNodeId,
                   DvText name,
                   Archetyped archetypeDetails,
                   FeederAudit feederAudit,
                   java.util.Set<Link> links,
                   java.util.List<Section> content,
                   EventContext context,
                   DvCodedText category,
                   CodePhrase territory,
                   TerminologyService terminologyService)

Constructs a Locatable

Parameters:

uid - null if not specified

archetypeNodeId -

name -

archetypeDetails - null if not specified

feederAudit - null if not specified

links - null if not specified

content - null if not specified

context -

category -

territory -

Throws:

java.lang.IllegalArgumentException - if name null or archetypeNodeId null or links not null and empty

Method Detail

getContent

public java.util.List<Section> getContent()

The clinical session content of this Composition, ie the information generated in the clinical session.

Returns:

unmodibialbe list of section or null if not present

getContext

public EventContext getContext()

The clinical session context of this Composition, ie the contextual attributes of the clinical session.

Returns:

context

getCategory

public DvCodedText getCategory()

Indicates what broad category this Composition is belogs to, eg "persistent" - of longitudinal validity, "event", "process" etc

Returns:

category

isPersistent

public boolean isPersistent()

True if category is a "persistent" type, False otherwise. Useful for finding Compositions in an EHR which are guaranteed to be of interest to most users.

Returns:

true if persistent

getTerritory

public CodePhrase getTerritory()

Name of territory in which this Composition was written. Coded from openEHR "countries" code set, which is an expression of the ISO 3166 standard.

Returns:

territory

pathOfItem

public java.lang.String pathOfItem(Locatable item)

String The path to an item relative to the root of this archetyped structure.

Specified by:

pathOfItem in class Locatable

Parameters:

item -

Returns:

string path

itemAtPath

public Locatable itemAtPath(java.lang.String path)

The item at a path that is relative to this item.

Specified by:

itemAtPath in class Locatable

Parameters:

path -

Returns:

relative path

validPath

public boolean validPath(java.lang.String path)

Return true if the path is valid with respect to the current item.

Specified by:

validPath in class Locatable

Parameters:

path -

Returns:

true if valid