Package org.hl7.fhir.r5.openehr

Class COMPOSITION

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.LogicalBase
org.hl7.fhir.r5.openehr.Any
org.hl7.fhir.r5.openehr.PATHABLE
org.hl7.fhir.r5.openehr.LOCATABLE
org.hl7.fhir.r5.openehr.COMPOSITION
All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType
public class COMPOSITION extends LOCATABLE implements org.hl7.fhir.instance.model.api.ICompositeType
Content of one version in a VERSIONED_COMPOSITION. 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. NOTE: It is strongly recommended that the inherited attribute uid be populated in Compositions, using the UID copied from the object_id() of the uid field of the enclosing VERSION object. For example, the ORIGINAL_VERSION.uid 87284370-2D4B-4e3d-A3F3-F303D2F4F34B::uk.nhs.ehr1::2 would be copied to the uid field of the Composition.
See Also:

  • Field Details

    • language

      protected CODE_PHRASE language
      Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY.language.

    • territory

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

    • category

      protected DV_CODED_TEXT category
      Temporal category of this Composition, i.e. 431|persistent| - of potential life-time validity;* 451|episodic| - valid over the life of a care episode;* 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment). or any other code defined in the openEHR terminology group 'category'.

    • context

      protected EVENT_CONTEXT context
      The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.

    • composer

      protected PARTY_PROXY composer
      The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.

    • contentList

      protected List<CONTENT_ITEM> contentList
      The content of this Composition.

  • Constructor Details

  • Method Details

    • getLanguage

      public CODE_PHRASE getLanguage()
      Returns:
      language (Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY.language.)

    • hasLanguage

      public boolean hasLanguage()

    • setLanguage

      public COMPOSITION setLanguage(CODE_PHRASE value)
      Parameters:
      value - language (Mandatory indicator of the localised language in which this Composition is written. Coded from openEHR Code Set languages. The language of an Entry if different from the Composition is indicated in ENTRY.language.)

    • getTerritory

      public CODE_PHRASE getTerritory()
      Returns:
      territory (Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.)

    • hasTerritory

      public boolean hasTerritory()

    • setTerritory

      public COMPOSITION setTerritory(CODE_PHRASE value)
      Parameters:
      value - territory (Name of territory in which this Composition was written. Coded from openEHR countries code set, which is an expression of the ISO 3166 standard.)

    • getCategory

      public DV_CODED_TEXT getCategory()
      Returns:
      category (Temporal category of this Composition, i.e. 431|persistent| - of potential life-time validity;* 451|episodic| - valid over the life of a care episode;* 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment). or any other code defined in the openEHR terminology group 'category'.)

    • hasCategory

      public boolean hasCategory()

    • setCategory

      public COMPOSITION setCategory(DV_CODED_TEXT value)
      Parameters:
      value - category (Temporal category of this Composition, i.e. 431|persistent| - of potential life-time validity;* 451|episodic| - valid over the life of a care episode;* 433|event| - valid at the time of recording (long-term validity requires subsequent clinical assessment). or any other code defined in the openEHR terminology group 'category'.)

    • getContext

      public EVENT_CONTEXT getContext()
      Returns:
      context (The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.)

    • hasContext

      public boolean hasContext()

    • setContext

      public COMPOSITION setContext(EVENT_CONTEXT value)
      Parameters:
      value - context (The clinical session context of this Composition, i.e. the contextual attributes of the clinical session.)

    • getComposer

      public PARTY_PROXY getComposer()
      Returns:
      composer (The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.)

    • hasComposer

      public boolean hasComposer()

    • setComposer

      public COMPOSITION setComposer(PARTY_PROXY value)
      Parameters:
      value - composer (The person primarily responsible for the content of the Composition (but not necessarily its committal into the EHR system). This is the identifier which should appear on the screen. It may or may not be the person who entered the data. When it is the patient, the special self instance of PARTY_PROXY will be used.)

    • getContentList

      public List<CONTENT_ITEM> getContentList()
      Returns:
      invalid reference 
      #content
      (The content of this Composition.)

    • setContentList

      public COMPOSITION setContentList(List<CONTENT_ITEM> theContent)
      Returns:
      Returns a reference to this for easy method chaining

    • hasContent

      public boolean hasContent()

    • addContent

      public COMPOSITION addContent(CONTENT_ITEM t)

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class PATHABLE

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class PATHABLE
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class LOCATABLE
      Returns:
      the FHIR type name of the instance (not the java class name)

    • copy

      public COMPOSITION copy()
      Specified by:
      copy in class LOCATABLE

    • copyValues

      public void copyValues(COMPOSITION dst)

    • typedCopy

      protected COMPOSITION typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class PATHABLE

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class PATHABLE

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class PATHABLE