Composition (HAPI FHIR Structures - HL7.org DSTU2 1.3 API)

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.Composition

All Implemented Interfaces:

Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class Composition
extends DomainResource
```
A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Composition.CompositionAttestationMode`
`static class`	`Composition.CompositionAttestationModeEnumFactory`
`static class`	`Composition.CompositionAttesterComponent`
`static class`	`Composition.CompositionEventComponent`
`static class`	`Composition.CompositionStatus`
`static class`	`Composition.CompositionStatusEnumFactory`
`static class`	`Composition.SectionComponent`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SP_ATTESTER`
`static String`	`SP_AUTHOR`
`static String`	`SP_CLASS`
`static String`	`SP_CONFIDENTIALITY`
`static String`	`SP_CONTEXT`
`static String`	`SP_DATE`
`static String`	`SP_ENCOUNTER`
`static String`	`SP_ENTRY`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_PATIENT`
`static String`	`SP_PERIOD`
`static String`	`SP_SECTION`
`static String`	`SP_STATUS`
`static String`	`SP_SUBJECT`
`static String`	`SP_TITLE`
`static String`	`SP_TYPE`

Constructor Summary

Constructors
Constructor and Description
`Composition()`
`Composition(DateTimeType date, CodeableConcept type, StringType title, Enumeration<Composition.CompositionStatus> status, Reference subject)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Composition.CompositionAttesterComponent`	`addAttester()`
`Composition`	`addAttester(Composition.CompositionAttesterComponent t)`
`Reference`	`addAuthor()`
`Composition`	`addAuthor(Reference t)`
`Composition.CompositionEventComponent`	`addEvent()`
`Composition`	`addEvent(Composition.CompositionEventComponent t)`
`Composition.SectionComponent`	`addSection()`
`Composition`	`addSection(Composition.SectionComponent t)`
`Composition`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`List<Composition.CompositionAttesterComponent>`	`getAttester()`
`List<Reference>`	`getAuthor()`
`List<Resource>`	`getAuthorTarget()`
`CodeableConcept`	`getClass_()`
`String`	`getConfidentiality()`
`CodeType`	`getConfidentialityElement()`
`Reference`	`getCustodian()`
`Organization`	`getCustodianTarget()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Composition.CompositionEventComponent>`	`getEvent()`
`Identifier`	`getIdentifier()`
`ResourceType`	`getResourceType()`
`List<Composition.SectionComponent>`	`getSection()`
`Composition.CompositionStatus`	`getStatus()`
`Enumeration<Composition.CompositionStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`CodeableConcept`	`getType()`
`boolean`	`hasAttester()`
`boolean`	`hasAuthor()`
`boolean`	`hasClass_()`
`boolean`	`hasConfidentiality()`
`boolean`	`hasConfidentialityElement()`
`boolean`	`hasCustodian()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasEncounter()`
`boolean`	`hasEvent()`
`boolean`	`hasIdentifier()`
`boolean`	`hasSection()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`Composition`	`setClass_(CodeableConcept value)`
`Composition`	`setConfidentiality(String value)`
`Composition`	`setConfidentialityElement(CodeType value)`
`Composition`	`setCustodian(Reference value)`
`Composition`	`setCustodianTarget(Organization value)`
`Composition`	`setDate(Date value)`
`Composition`	`setDateElement(DateTimeType value)`
`Composition`	`setEncounter(Reference value)`
`Composition`	`setEncounterTarget(Encounter value)`
`Composition`	`setIdentifier(Identifier value)`
`Composition`	`setStatus(Composition.CompositionStatus value)`
`Composition`	`setStatusElement(Enumeration<Composition.CompositionStatus> value)`
`Composition`	`setSubject(Reference value)`
`Composition`	`setSubjectTarget(Resource value)`
`Composition`	`setTitle(String value)`
`Composition`	`setTitleElement(StringType value)`
`Composition`	`setType(CodeableConcept value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getMeta, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
setId

- Field Detail
  - SP_DATE
```
public static final String SP_DATE
```
    See Also:
    
    Constant Field Values
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_PERIOD
```
public static final String SP_PERIOD
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    See Also:
    
    Constant Field Values
  - SP_CONFIDENTIALITY
```
public static final String SP_CONFIDENTIALITY
```
    See Also:
    
    Constant Field Values
  - SP_SECTION
```
public static final String SP_SECTION
```
    See Also:
    
    Constant Field Values
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    See Also:
    
    Constant Field Values
  - SP_TYPE
```
public static final String SP_TYPE
```
    See Also:
    
    Constant Field Values
  - SP_TITLE
```
public static final String SP_TITLE
```
    See Also:
    
    Constant Field Values
  - SP_ATTESTER
```
public static final String SP_ATTESTER
```
    See Also:
    
    Constant Field Values
  - SP_ENTRY
```
public static final String SP_ENTRY
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_CONTEXT
```
public static final String SP_CONTEXT
```
    See Also:
    
    Constant Field Values
  - SP_CLASS
```
public static final String SP_CLASS
```
    See Also:
    
    Constant Field Values
  - SP_STATUS
```
public static final String SP_STATUS
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Composition
```
public Composition()
```
  - Composition
```
public Composition(DateTimeType date,
                   CodeableConcept type,
                   StringType title,
                   Enumeration<Composition.CompositionStatus> status,
                   Reference subject)
```
- Method Detail
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public Composition setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (Logical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.)
  - getDateElement
```
public DateTimeType getDateElement()
```
    Returns:
    
    date (The composition editing time, when the composition was last logically changed by the author.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - hasDateElement
```
public boolean hasDateElement()
```
  - hasDate
```
public boolean hasDate()
```
  - setDateElement
```
public Composition setDateElement(DateTimeType value)
```
    Parameters:
    
    value - date (The composition editing time, when the composition was last logically changed by the author.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
  - getDate
```
public Date getDate()
```
    Returns:
    
    The composition editing time, when the composition was last logically changed by the author.
  - setDate
```
public Composition setDate(Date value)
```
    Parameters:
    
    value - The composition editing time, when the composition was last logically changed by the author.
  - getType
```
public CodeableConcept getType()
```
    Returns:
    
    type (Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.)
  - hasType
```
public boolean hasType()
```
  - setType
```
public Composition setType(CodeableConcept value)
```
    Parameters:
    
    value - type (Specifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.)
  - getClass_
```
public CodeableConcept getClass_()
```
    Returns:
    
    class_ (A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.)
  - hasClass_
```
public boolean hasClass_()
```
  - setClass_
```
public Composition setClass_(CodeableConcept value)
```
    Parameters:
    
    value - class_ (A categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.)
  - getTitleElement
```
public StringType getTitleElement()
```
    Returns:
    
    title (Official human-readable label for the composition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - hasTitleElement
```
public boolean hasTitleElement()
```
  - hasTitle
```
public boolean hasTitle()
```
  - setTitleElement
```
public Composition setTitleElement(StringType value)
```
    Parameters:
    
    value - title (Official human-readable label for the composition.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
  - getTitle
```
public String getTitle()
```
    Returns:
    
    Official human-readable label for the composition.
  - setTitle
```
public Composition setTitle(String value)
```
    Parameters:
    
    value - Official human-readable label for the composition.
  - getStatusElement
```
public Enumeration<Composition.CompositionStatus> getStatusElement()
```
    Returns:
    
    status (The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - hasStatusElement
```
public boolean hasStatusElement()
```
  - hasStatus
```
public boolean hasStatus()
```
  - setStatusElement
```
public Composition setStatusElement(Enumeration<Composition.CompositionStatus> value)
```
    Parameters:
    
    value - status (The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
  - getStatus
```
public Composition.CompositionStatus getStatus()
```
    Returns:
    
    The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
  - setStatus
```
public Composition setStatus(Composition.CompositionStatus value)
```
    Parameters:
    
    value - The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
  - getConfidentialityElement
```
public CodeType getConfidentialityElement()
```
    Returns:
    
    confidentiality (The code specifying the level of confidentiality of the Composition.). This is the underlying object with id, value and extensions. The accessor "getConfidentiality" gives direct access to the value
  - hasConfidentialityElement
```
public boolean hasConfidentialityElement()
```
  - hasConfidentiality
```
public boolean hasConfidentiality()
```
  - setConfidentialityElement
```
public Composition setConfidentialityElement(CodeType value)
```
    Parameters:
    
    value - confidentiality (The code specifying the level of confidentiality of the Composition.). This is the underlying object with id, value and extensions. The accessor "getConfidentiality" gives direct access to the value
  - getConfidentiality
```
public String getConfidentiality()
```
    Returns:
    
    The code specifying the level of confidentiality of the Composition.
  - setConfidentiality
```
public Composition setConfidentiality(String value)
```
    Parameters:
    
    value - The code specifying the level of confidentiality of the Composition.
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public Composition setSubject(Reference value)
```
    Parameters:
    
    value - subject (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)
  - setSubjectTarget
```
public Composition setSubjectTarget(Resource value)
```
    Parameters:
    
    value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Who or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).)
  - getAuthor
```
public List<Reference> getAuthor()
```
    Returns:
    
    author (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
  - hasAuthor
```
public boolean hasAuthor()
```
  - addAuthor
```
public Reference addAuthor()
```
    Returns:
    
    author (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
  - addAuthor
```
public Composition addAuthor(Reference t)
```
  - getAuthorTarget
```
public List<Resource> getAuthorTarget()
```
    Returns:
    
    author (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
  - getAttester
```
public List<Composition.CompositionAttesterComponent> getAttester()
```
    Returns:
    
    attester (A participant who has attested to the accuracy of the composition/document.)
  - hasAttester
```
public boolean hasAttester()
```
  - addAttester
```
public Composition.CompositionAttesterComponent addAttester()
```
    Returns:
    
    attester (A participant who has attested to the accuracy of the composition/document.)
  - addAttester
```
public Composition addAttester(Composition.CompositionAttesterComponent t)
```
  - getCustodian
```
public Reference getCustodian()
```
    Returns:
    
    custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
  - hasCustodian
```
public boolean hasCustodian()
```
  - setCustodian
```
public Composition setCustodian(Reference value)
```
    Parameters:
    
    value - custodian (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
  - getCustodianTarget
```
public Organization getCustodianTarget()
```
    Returns:
    
    custodian The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
  - setCustodianTarget
```
public Composition setCustodianTarget(Organization value)
```
    Parameters:
    
    value - custodian The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
  - getEvent
```
public List<Composition.CompositionEventComponent> getEvent()
```
    Returns:
    
    event (The clinical service, such as a colonoscopy or an appendectomy, being documented.)
  - hasEvent
```
public boolean hasEvent()
```
  - addEvent
```
public Composition.CompositionEventComponent addEvent()
```
    Returns:
    
    event (The clinical service, such as a colonoscopy or an appendectomy, being documented.)
  - addEvent
```
public Composition addEvent(Composition.CompositionEventComponent t)
```
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (Describes the clinical encounter or type of care this documentation is associated with.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public Composition setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (Describes the clinical encounter or type of care this documentation is associated with.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Describes the clinical encounter or type of care this documentation is associated with.)
  - setEncounterTarget
```
public Composition setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Describes the clinical encounter or type of care this documentation is associated with.)
  - getSection
```
public List<Composition.SectionComponent> getSection()
```
    Returns:
    
    section (The root of the sections that make up the composition.)
  - hasSection
```
public boolean hasSection()
```
  - addSection
```
public Composition.SectionComponent addSection()
```
    Returns:
    
    section (The root of the sections that make up the composition.)
  - addSection
```
public Composition addSection(Composition.SectionComponent t)
```
  - copy
```
public Composition copy()
```
    Specified by:
    
    copy in class DomainResource
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class DomainResource
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class DomainResource
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Composition

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.instance.model.DomainResource

Methods inherited from class org.hl7.fhir.instance.model.Resource

Methods inherited from class org.hl7.fhir.instance.model.BaseResource

Methods inherited from class org.hl7.fhir.instance.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

Field Detail

SP_DATE

SP_IDENTIFIER

SP_PERIOD

SP_SUBJECT

SP_AUTHOR

SP_CONFIDENTIALITY

SP_SECTION

SP_ENCOUNTER

SP_TYPE

SP_TITLE

SP_ATTESTER

SP_ENTRY

SP_PATIENT

SP_CONTEXT

SP_CLASS

SP_STATUS

Constructor Detail

Composition

Composition

Method Detail

getIdentifier

hasIdentifier

setIdentifier

getDateElement

hasDateElement

hasDate

setDateElement

getDate

setDate

getType

hasType

setType

getClass_

hasClass_

setClass_

getTitleElement

hasTitleElement

hasTitle

setTitleElement

getTitle

setTitle

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getConfidentialityElement

hasConfidentialityElement

hasConfidentiality

setConfidentialityElement

getConfidentiality

setConfidentiality

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getAuthor

hasAuthor

addAuthor

addAuthor

getAuthorTarget

getAttester

hasAttester

addAttester

addAttester