Composition.CompositionEventComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.dstu3.model.Base
- - org.hl7.fhir.dstu3.model.Element
  - - org.hl7.fhir.dstu3.model.BackboneElement
    - - org.hl7.fhir.dstu3.model.Composition.CompositionEventComponent

All Implemented Interfaces:

IElement, Serializable, IBase, IBaseBackboneElement, IBaseElement, IBaseHasExtensions, IBaseHasModifierExtensions

Enclosing class:

Composition
```
public static class Composition.CompositionEventComponent
extends BackboneElement
implements IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<CodeableConcept>`	`code` This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
`protected List<Reference>`	`detail` The description and/or reference of the event(s) being documented.
`protected List<Resource>`	`detailTarget` The actual objects that are the target of the reference (The description and/or reference of the event(s) being documented.
`protected Period`	`period` The period of time covered by the documentation.

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.dstu3.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

CompositionEventComponent()
Constructor

Constructors
Constructor and Description
`CompositionEventComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`CodeableConcept`	`addCode()`
`Composition.CompositionEventComponent`	`addCode(CodeableConcept t)`
`Reference`	`addDetail()`
`Composition.CompositionEventComponent`	`addDetail(Reference t)`
`Composition.CompositionEventComponent`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`List<CodeableConcept>`	`getCode()`
`CodeableConcept`	`getCodeFirstRep()`
`List<Reference>`	`getDetail()`
`Reference`	`getDetailFirstRep()`
`List<Resource>`	`getDetailTarget()` Deprecated. Use Reference#setResource(IBaseResource) instead
`Period`	`getPeriod()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasCode()`
`boolean`	`hasDetail()`
`boolean`	`hasPeriod()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`Composition.CompositionEventComponent`	`setCode(List<CodeableConcept> theCode)`
`Composition.CompositionEventComponent`	`setDetail(List<Reference> theDetail)`
`Composition.CompositionEventComponent`	`setPeriod(Period value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement
addModifierExtension, addModifierExtension, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.dstu3.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, isResource, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

- Field Detail
  - code
```
protected List<CodeableConcept> code
```
    This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
  - period
```
protected Period period
```
    The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
  - detail
```
protected List<Reference> detail
```
    The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
  - detailTarget
```
protected List<Resource> detailTarget
```
    The actual objects that are the target of the reference (The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.)
- Constructor Detail
  - CompositionEventComponent
```
public CompositionEventComponent()
```
    Constructor
- Method Detail
  - getCode
```
public List<CodeableConcept> getCode()
```
    Returns:
    
    code (This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.)
  - setCode
```
public Composition.CompositionEventComponent setCode(List<CodeableConcept> theCode)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasCode
```
public boolean hasCode()
```
  - addCode
```
public CodeableConcept addCode()
```
  - addCode
```
public Composition.CompositionEventComponent addCode(CodeableConcept t)
```
  - getCodeFirstRep
```
public CodeableConcept getCodeFirstRep()
```
    Returns:
    
    The first repetition of repeating field code, creating it if it does not already exist
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public Composition.CompositionEventComponent setPeriod(Period value)
```
    Parameters:
    
    value - period (The period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.)
  - getDetail
```
public List<Reference> getDetail()
```
    Returns:
    
    detail (The description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.)
  - setDetail
```
public Composition.CompositionEventComponent setDetail(List<Reference> theDetail)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasDetail
```
public boolean hasDetail()
```
  - addDetail
```
public Reference addDetail()
```
  - addDetail
```
public Composition.CompositionEventComponent addDetail(Reference t)
```
  - getDetailFirstRep
```
public Reference getDetailFirstRep()
```
    Returns:
    
    The first repetition of repeating field detail, creating it if it does not already exist
  - getDetailTarget
```
@Deprecated
public List<Resource> getDetailTarget()
```
    Deprecated. Use Reference#setResource(IBaseResource) instead
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    FHIRException
  - addChild
```
public Base addChild(String name)
              throws FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    FHIRException
  - copy
```
public Composition.CompositionEventComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - equalsDeep
```
public boolean equalsDeep(Base other)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class Composition.CompositionEventComponent

Field Summary

Fields inherited from class org.hl7.fhir.dstu3.model.BackboneElement

Fields inherited from class org.hl7.fhir.dstu3.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.dstu3.model.BackboneElement

Methods inherited from class org.hl7.fhir.dstu3.model.Element

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

code

period

detail

detailTarget

Constructor Detail

CompositionEventComponent

Method Detail

getCode

setCode

hasCode

addCode

addCode

getCodeFirstRep

getPeriod

hasPeriod

setPeriod

getDetail

setDetail

hasDetail

addDetail

addDetail

getDetailFirstRep

getDetailTarget

listChildren

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType