Composition (org.hl7.fhir.r4 5.4.0 API)

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

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource
```
public class Composition
extends DomainResource
```
A set of healthcare-related information that is assembled together into a single logical package 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. A Composition defines the structure and narrative content necessary for a document. However, a Composition alone does not constitute a document. Rather, the Composition must be the first entry in a Bundle where Bundle.type=document, and any other resources referenced from Composition must be included as subsequent entries in the Bundle (for example Patient, Practitioner, Encounter, etc.).

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.CompositionRelatesToComponent`
`static class`	`Composition.CompositionStatus`
`static class`	`Composition.CompositionStatusEnumFactory`
`static class`	`Composition.DocumentConfidentiality`
`static class`	`Composition.DocumentConfidentialityEnumFactory`
`static class`	`Composition.DocumentRelationshipType`
`static class`	`Composition.DocumentRelationshipTypeEnumFactory`
`static class`	`Composition.SectionComponent`
`static class`	`Composition.SectionMode`
`static class`	`Composition.SectionModeEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Composition.CompositionAttesterComponent>`	`attester` A participant who has attested to the accuracy of the composition/document.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ATTESTER` Fluent Client search parameter constant for attester
`protected List<Reference>`	`author` Identifies who is responsible for the information in the composition, not necessarily who typed it in.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`AUTHOR` Fluent Client search parameter constant for author
`protected List<Resource>`	`authorTarget` The actual objects that are the target of the reference (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
`protected List<CodeableConcept>`	`category` A categorization for the type of the composition - helps for indexing and searching.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CATEGORY` Fluent Client search parameter constant for category
`protected Enumeration<Composition.DocumentConfidentiality>`	`confidentiality` The code specifying the level of confidentiality of the Composition.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CONFIDENTIALITY` Fluent Client search parameter constant for confidentiality
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`CONTEXT` Fluent Client search parameter constant for context
`protected Reference`	`custodian` Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
`protected Organization`	`custodianTarget` The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
`protected DateTimeType`	`date` The composition editing time, when the composition was last logically changed by the author.
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`DATE` Fluent Client search parameter constant for date
`protected Reference`	`encounter` Describes the clinical encounter or type of care this documentation is associated with.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (Describes the clinical encounter or type of care this documentation is associated with.)
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENTRY` Fluent Client search parameter constant for entry
`protected List<Composition.CompositionEventComponent>`	`event` The clinical service, such as a colonoscopy or an appendectomy, being documented.
`protected Identifier`	`identifier` A version-independent identifier for the Composition.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ATTESTER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_AUTHOR` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENCOUNTER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENTRY` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_RELATED_REF` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static ca.uhn.fhir.rest.gclient.DateClientParam`	`PERIOD` Fluent Client search parameter constant for period
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`RELATED_ID` Fluent Client search parameter constant for related-id
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`RELATED_REF` Fluent Client search parameter constant for related-ref
`protected List<Composition.CompositionRelatesToComponent>`	`relatesTo` Relationships that this composition has with other compositions or documents that already exist.
`protected List<Composition.SectionComponent>`	`section` The root of the sections that make up the composition.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`SECTION` Fluent Client search parameter constant for section
`static String`	`SP_ATTESTER` Search parameter: attester
`static String`	`SP_AUTHOR` Search parameter: author
`static String`	`SP_CATEGORY` Search parameter: category
`static String`	`SP_CONFIDENTIALITY` Search parameter: confidentiality
`static String`	`SP_CONTEXT` Search parameter: context
`static String`	`SP_DATE` Search parameter: date
`static String`	`SP_ENCOUNTER` Search parameter: encounter
`static String`	`SP_ENTRY` Search parameter: entry
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PERIOD` Search parameter: period
`static String`	`SP_RELATED_ID` Search parameter: related-id
`static String`	`SP_RELATED_REF` Search parameter: related-ref
`static String`	`SP_SECTION` Search parameter: section
`static String`	`SP_STATUS` Search parameter: status
`static String`	`SP_SUBJECT` Search parameter: subject
`static String`	`SP_TITLE` Search parameter: title
`static String`	`SP_TYPE` Search parameter: type
`protected Enumeration<Composition.CompositionStatus>`	`status` The workflow/clinical status of this composition.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`STATUS` Fluent Client search parameter constant for status
`protected Reference`	`subject` Who or what the composition is about.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (Who or what the composition is about.
`protected StringType`	`title` Official human-readable label for the composition.
`static ca.uhn.fhir.rest.gclient.StringClientParam`	`TITLE` Fluent Client search parameter constant for title
`protected CodeableConcept`	`type` Specifies the particular kind of composition (e.g.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Composition.CompositionAttesterComponent`	`addAttester()`
`Composition`	`addAttester(Composition.CompositionAttesterComponent t)`
`Reference`	`addAuthor()`
`Composition`	`addAuthor(Reference t)`
`CodeableConcept`	`addCategory()`
`Composition`	`addCategory(CodeableConcept t)`
`Base`	`addChild(String name)`
`Composition.CompositionEventComponent`	`addEvent()`
`Composition`	`addEvent(Composition.CompositionEventComponent t)`
`Composition.CompositionRelatesToComponent`	`addRelatesTo()`
`Composition`	`addRelatesTo(Composition.CompositionRelatesToComponent t)`
`Composition.SectionComponent`	`addSection()`
`Composition`	`addSection(Composition.SectionComponent t)`
`Composition`	`copy()`
`void`	`copyValues(Composition dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`List<Composition.CompositionAttesterComponent>`	`getAttester()`
`Composition.CompositionAttesterComponent`	`getAttesterFirstRep()`
`List<Reference>`	`getAuthor()`
`Reference`	`getAuthorFirstRep()`
`List<Resource>`	`getAuthorTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`List<CodeableConcept>`	`getCategory()`
`CodeableConcept`	`getCategoryFirstRep()`
`Composition.DocumentConfidentiality`	`getConfidentiality()`
`Enumeration<Composition.DocumentConfidentiality>`	`getConfidentialityElement()`
`Reference`	`getCustodian()`
`Organization`	`getCustodianTarget()`
`Date`	`getDate()`
`DateTimeType`	`getDateElement()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Composition.CompositionEventComponent>`	`getEvent()`
`Composition.CompositionEventComponent`	`getEventFirstRep()`
`Identifier`	`getIdentifier()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<Composition.CompositionRelatesToComponent>`	`getRelatesTo()`
`Composition.CompositionRelatesToComponent`	`getRelatesToFirstRep()`
`ResourceType`	`getResourceType()`
`List<Composition.SectionComponent>`	`getSection()`
`Composition.SectionComponent`	`getSectionFirstRep()`
`Composition.CompositionStatus`	`getStatus()`
`Enumeration<Composition.CompositionStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`String`	`getTitle()`
`StringType`	`getTitleElement()`
`CodeableConcept`	`getType()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasAttester()`
`boolean`	`hasAuthor()`
`boolean`	`hasCategory()`
`boolean`	`hasConfidentiality()`
`boolean`	`hasConfidentialityElement()`
`boolean`	`hasCustodian()`
`boolean`	`hasDate()`
`boolean`	`hasDateElement()`
`boolean`	`hasEncounter()`
`boolean`	`hasEvent()`
`boolean`	`hasIdentifier()`
`boolean`	`hasRelatesTo()`
`boolean`	`hasSection()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`hasTitle()`
`boolean`	`hasTitleElement()`
`boolean`	`hasType()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`Composition`	`setAttester(List<Composition.CompositionAttesterComponent> theAttester)`
`Composition`	`setAuthor(List<Reference> theAuthor)`
`Composition`	`setCategory(List<CodeableConcept> theCategory)`
`Composition`	`setConfidentiality(Composition.DocumentConfidentiality value)`
`Composition`	`setConfidentialityElement(Enumeration<Composition.DocumentConfidentiality> 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`	`setEvent(List<Composition.CompositionEventComponent> theEvent)`
`Composition`	`setIdentifier(Identifier value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`Composition`	`setRelatesTo(List<Composition.CompositionRelatesToComponent> theRelatesTo)`
`Composition`	`setSection(List<Composition.SectionComponent> theSection)`
`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)`
`protected Composition`	`typedCopy()`

Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

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

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected Identifier identifier
```
    A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.
  - status
```
protected Enumeration<Composition.CompositionStatus> status
```
    The workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
  - type
```
protected CodeableConcept 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.
  - category
```
protected List<CodeableConcept> category
```
    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.
  - subject
```
protected Reference 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).
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (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).)
  - encounter
```
protected Reference encounter
```
    Describes the clinical encounter or type of care this documentation is associated with.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (Describes the clinical encounter or type of care this documentation is associated with.)
  - date
```
protected DateTimeType date
```
    The composition editing time, when the composition was last logically changed by the author.
  - author
```
protected List<Reference> author
```
    Identifies who is responsible for the information in the composition, not necessarily who typed it in.
  - authorTarget
```
protected List<Resource> authorTarget
```
    The actual objects that are the target of the reference (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
  - title
```
protected StringType title
```
    Official human-readable label for the composition.
  - confidentiality
```
protected Enumeration<Composition.DocumentConfidentiality> confidentiality
```
    The code specifying the level of confidentiality of the Composition.
  - attester
```
protected List<Composition.CompositionAttesterComponent> attester
```
    A participant who has attested to the accuracy of the composition/document.
  - custodian
```
protected Reference custodian
```
    Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
  - custodianTarget
```
protected Organization custodianTarget
```
    The actual object that is the target of the reference (Identifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.)
  - relatesTo
```
protected List<Composition.CompositionRelatesToComponent> relatesTo
```
    Relationships that this composition has with other compositions or documents that already exist.
  - event
```
protected List<Composition.CompositionEventComponent> event
```
    The clinical service, such as a colonoscopy or an appendectomy, being documented.
  - section
```
protected List<Composition.SectionComponent> section
```
    The root of the sections that make up the composition.
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter: date
    Description: Composition editing time
    Type: date
    Path: Composition.date
    
    See Also:
    
    Constant Field Values
  - DATE
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: Composition editing time
    Type: date
    Path: Composition.date
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: Version-independent identifier for the Composition
    Type: token
    Path: Composition.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Version-independent identifier for the Composition
    Type: token
    Path: Composition.identifier
  - SP_PERIOD
```
public static final String SP_PERIOD
```
    Search parameter: period
    Description: The period covered by the documentation
    Type: date
    Path: Composition.event.period
    
    See Also:
    
    Constant Field Values
  - PERIOD
```
public static final ca.uhn.fhir.rest.gclient.DateClientParam PERIOD
```
    Fluent Client search parameter constant for period
    Description: The period covered by the documentation
    Type: date
    Path: Composition.event.period
  - SP_RELATED_ID
```
public static final String SP_RELATED_ID
```
    Search parameter: related-id
    Description: Target of the relationship
    Type: token
    Path: Composition.relatesTo.targetIdentifier
    
    See Also:
    
    Constant Field Values
  - RELATED_ID
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam RELATED_ID
```
    Fluent Client search parameter constant for related-id
    Description: Target of the relationship
    Type: token
    Path: Composition.relatesTo.targetIdentifier
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter: subject
    Description: Who and/or what the composition is about
    Type: reference
    Path: Composition.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: Who and/or what the composition is about
    Type: reference
    Path: Composition.subject
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:subject".
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter: author
    Description: Who and/or what authored the composition
    Type: reference
    Path: Composition.author
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description: Who and/or what authored the composition
    Type: reference
    Path: Composition.author
  - INCLUDE_AUTHOR
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:author".
  - SP_CONFIDENTIALITY
```
public static final String SP_CONFIDENTIALITY
```
    Search parameter: confidentiality
    Description: As defined by affinity domain
    Type: token
    Path: Composition.confidentiality
    
    See Also:
    
    Constant Field Values
  - CONFIDENTIALITY
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONFIDENTIALITY
```
    Fluent Client search parameter constant for confidentiality
    Description: As defined by affinity domain
    Type: token
    Path: Composition.confidentiality
  - SP_SECTION
```
public static final String SP_SECTION
```
    Search parameter: section
    Description: Classification of section (recommended)
    Type: token
    Path: Composition.section.code
    
    See Also:
    
    Constant Field Values
  - SECTION
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam SECTION
```
    Fluent Client search parameter constant for section
    Description: Classification of section (recommended)
    Type: token
    Path: Composition.section.code
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter: encounter
    Description: Context of the Composition
    Type: reference
    Path: Composition.encounter
    
    See Also:
    
    Constant Field Values
  - ENCOUNTER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
```
    Fluent Client search parameter constant for encounter
    Description: Context of the Composition
    Type: reference
    Path: Composition.encounter
  - INCLUDE_ENCOUNTER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:encounter".
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter: type
    Description: Kind of composition (LOINC if possible)
    Type: token
    Path: Composition.type
    
    See Also:
    
    Constant Field Values
  - TYPE
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: Kind of composition (LOINC if possible)
    Type: token
    Path: Composition.type
  - SP_TITLE
```
public static final String SP_TITLE
```
    Search parameter: title
    Description: Human Readable name/title
    Type: string
    Path: Composition.title
    
    See Also:
    
    Constant Field Values
  - TITLE
```
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
```
    Fluent Client search parameter constant for title
    Description: Human Readable name/title
    Type: string
    Path: Composition.title
  - SP_ATTESTER
```
public static final String SP_ATTESTER
```
    Search parameter: attester
    Description: Who attested the composition
    Type: reference
    Path: Composition.attester.party
    
    See Also:
    
    Constant Field Values
  - ATTESTER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ATTESTER
```
    Fluent Client search parameter constant for attester
    Description: Who attested the composition
    Type: reference
    Path: Composition.attester.party
  - INCLUDE_ATTESTER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ATTESTER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:attester".
  - SP_ENTRY
```
public static final String SP_ENTRY
```
    Search parameter: entry
    Description: A reference to data that supports this section
    Type: reference
    Path: Composition.section.entry
    
    See Also:
    
    Constant Field Values
  - ENTRY
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENTRY
```
    Fluent Client search parameter constant for entry
    Description: A reference to data that supports this section
    Type: reference
    Path: Composition.section.entry
  - INCLUDE_ENTRY
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENTRY
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:entry".
  - SP_RELATED_REF
```
public static final String SP_RELATED_REF
```
    Search parameter: related-ref
    Description: Target of the relationship
    Type: reference
    Path: Composition.relatesTo.targetReference
    
    See Also:
    
    Constant Field Values
  - RELATED_REF
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RELATED_REF
```
    Fluent Client search parameter constant for related-ref
    Description: Target of the relationship
    Type: reference
    Path: Composition.relatesTo.targetReference
  - INCLUDE_RELATED_REF
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_RELATED_REF
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:related-ref".
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter: patient
    Description: Who and/or what the composition is about
    Type: reference
    Path: Composition.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Who and/or what the composition is about
    Type: reference
    Path: Composition.subject
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Composition:patient".
  - SP_CONTEXT
```
public static final String SP_CONTEXT
```
    Search parameter: context
    Description: Code(s) that apply to the event being documented
    Type: token
    Path: Composition.event.code
    
    See Also:
    
    Constant Field Values
  - CONTEXT
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT
```
    Fluent Client search parameter constant for context
    Description: Code(s) that apply to the event being documented
    Type: token
    Path: Composition.event.code
  - SP_CATEGORY
```
public static final String SP_CATEGORY
```
    Search parameter: category
    Description: Categorization of Composition
    Type: token
    Path: Composition.category
    
    See Also:
    
    Constant Field Values
  - CATEGORY
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
```
    Fluent Client search parameter constant for category
    Description: Categorization of Composition
    Type: token
    Path: Composition.category
  - SP_STATUS
```
public static final String SP_STATUS
```
    Search parameter: status
    Description: preliminary | final | amended | entered-in-error
    Type: token
    Path: Composition.status
    
    See Also:
    
    Constant Field Values
  - STATUS
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
```
    Fluent Client search parameter constant for status
    Description: preliminary | final | amended | entered-in-error
    Type: token
    Path: Composition.status
- Constructor Detail
  - Composition
```
public Composition()
```
    Constructor
  - Composition
```
public Composition(Enumeration<Composition.CompositionStatus> status,
                   CodeableConcept type,
                   DateTimeType date,
                   StringType title)
```
    Constructor
- Method Detail
  - getIdentifier
```
public Identifier getIdentifier()
```
    Returns:
    
    identifier (A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - setIdentifier
```
public Composition setIdentifier(Identifier value)
```
    Parameters:
    
    value - identifier (A version-independent identifier for the Composition. This identifier stays constant as the composition is changed over time.)
  - 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.
  - 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.)
  - getCategory
```
public List<CodeableConcept> getCategory()
```
    Returns:
    
    category (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.)
  - setCategory
```
public Composition setCategory(List<CodeableConcept> theCategory)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCategory
```
public boolean hasCategory()
```
  - addCategory
```
public CodeableConcept addCategory()
```
  - addCategory
```
public Composition addCategory(CodeableConcept t)
```
  - getCategoryFirstRep
```
public CodeableConcept getCategoryFirstRep()
```
    Returns:
    
    The first repetition of repeating field category, creating it if it does not already exist
  - 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).)
  - 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.)
  - 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.
  - getAuthor
```
public List<Reference> getAuthor()
```
    Returns:
    
    author (Identifies who is responsible for the information in the composition, not necessarily who typed it in.)
  - setAuthor
```
public Composition setAuthor(List<Reference> theAuthor)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAuthor
```
public boolean hasAuthor()
```
  - addAuthor
```
public Reference addAuthor()
```
  - addAuthor
```
public Composition addAuthor(Reference t)
```
  - getAuthorFirstRep
```
public Reference getAuthorFirstRep()
```
    Returns:
    
    The first repetition of repeating field author, creating it if it does not already exist
  - getAuthorTarget
```
@Deprecated
public List<Resource> getAuthorTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - 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.
  - getConfidentialityElement
```
public Enumeration<Composition.DocumentConfidentiality> 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(Enumeration<Composition.DocumentConfidentiality> 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 Composition.DocumentConfidentiality getConfidentiality()
```
    Returns:
    
    The code specifying the level of confidentiality of the Composition.
  - setConfidentiality
```
public Composition setConfidentiality(Composition.DocumentConfidentiality value)
```
    Parameters:
    
    value - The code specifying the level of confidentiality of the Composition.
  - getAttester
```
public List<Composition.CompositionAttesterComponent> getAttester()
```
    Returns:
    
    attester (A participant who has attested to the accuracy of the composition/document.)
  - setAttester
```
public Composition setAttester(List<Composition.CompositionAttesterComponent> theAttester)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasAttester
```
public boolean hasAttester()
```
  - addAttester
```
public Composition.CompositionAttesterComponent addAttester()
```
  - addAttester
```
public Composition addAttester(Composition.CompositionAttesterComponent t)
```
  - getAttesterFirstRep
```
public Composition.CompositionAttesterComponent getAttesterFirstRep()
```
    Returns:
    
    The first repetition of repeating field attester, creating it if it does not already exist
  - 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.)
  - getRelatesTo
```
public List<Composition.CompositionRelatesToComponent> getRelatesTo()
```
    Returns:
    
    relatesTo (Relationships that this composition has with other compositions or documents that already exist.)
  - setRelatesTo
```
public Composition setRelatesTo(List<Composition.CompositionRelatesToComponent> theRelatesTo)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRelatesTo
```
public boolean hasRelatesTo()
```
  - addRelatesTo
```
public Composition.CompositionRelatesToComponent addRelatesTo()
```
  - addRelatesTo
```
public Composition addRelatesTo(Composition.CompositionRelatesToComponent t)
```
  - getRelatesToFirstRep
```
public Composition.CompositionRelatesToComponent getRelatesToFirstRep()
```
    Returns:
    
    The first repetition of repeating field relatesTo, creating it if it does not already exist
  - getEvent
```
public List<Composition.CompositionEventComponent> getEvent()
```
    Returns:
    
    event (The clinical service, such as a colonoscopy or an appendectomy, being documented.)
  - setEvent
```
public Composition setEvent(List<Composition.CompositionEventComponent> theEvent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasEvent
```
public boolean hasEvent()
```
  - addEvent
```
public Composition.CompositionEventComponent addEvent()
```
  - addEvent
```
public Composition addEvent(Composition.CompositionEventComponent t)
```
  - getEventFirstRep
```
public Composition.CompositionEventComponent getEventFirstRep()
```
    Returns:
    
    The first repetition of repeating field event, creating it if it does not already exist
  - getSection
```
public List<Composition.SectionComponent> getSection()
```
    Returns:
    
    section (The root of the sections that make up the composition.)
  - setSection
```
public Composition setSection(List<Composition.SectionComponent> theSection)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasSection
```
public boolean hasSection()
```
  - addSection
```
public Composition.SectionComponent addSection()
```
  - addSection
```
public Composition addSection(Composition.SectionComponent t)
```
  - getSectionFirstRep
```
public Composition.SectionComponent getSectionFirstRep()
```
    Returns:
    
    The first repetition of repeating field section, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class DomainResource
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class DomainResource
    
    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 DomainResource
    
    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 DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class DomainResource
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class DomainResource
    
    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 DomainResource
  - copy
```
public Composition copy()
```
    Specified by:
    
    copy in class DomainResource
  - copyValues
```
public void copyValues(Composition dst)
```
  - typedCopy
```
protected Composition typedCopy()
```
  - 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 org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class Composition

Nested Class Summary

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

Fields inherited from class org.hl7.fhir.r4.model.Resource

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.hl7.fhir.r4.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

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

Field Detail

identifier

status

type

category

subject

subjectTarget

encounter

encounterTarget

date

author

authorTarget

title

confidentiality

attester

custodian

custodianTarget

relatesTo

event

section

SP_DATE

DATE

SP_IDENTIFIER

IDENTIFIER

SP_PERIOD

PERIOD

SP_RELATED_ID

RELATED_ID

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_AUTHOR

AUTHOR

INCLUDE_AUTHOR

SP_CONFIDENTIALITY

CONFIDENTIALITY

SP_SECTION

SECTION

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_TYPE

TYPE

SP_TITLE

TITLE

SP_ATTESTER

ATTESTER

INCLUDE_ATTESTER

SP_ENTRY

ENTRY

INCLUDE_ENTRY

SP_RELATED_REF

RELATED_REF

INCLUDE_RELATED_REF

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_CONTEXT

CONTEXT

SP_CATEGORY

CATEGORY

SP_STATUS

STATUS