DocumentReference.DocumentReferenceContextComponent (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.BackboneElement
    - - org.hl7.fhir.r4.model.DocumentReference.DocumentReferenceContextComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

DocumentReference
```
public static class DocumentReference.DocumentReferenceContextComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Reference`	`encounter` Describes the clinical encounter or type of care that the document content is associated with.
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (Describes the clinical encounter or type of care that the document content is associated with.)
`protected List<CodeableConcept>`	`event` This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented.
`protected CodeableConcept`	`facilityType` The kind of facility where the patient was seen.
`protected Period`	`period` The time period over which the service that is described by the document was provided.
`protected CodeableConcept`	`practiceSetting` This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
`protected List<DocumentReference.DocumentReferenceContextRelatedComponent>`	`related` Related identifiers or resources associated with the DocumentReference.
`protected Reference`	`sourcePatientInfo` The Patient Information as known when the document was published.
`protected Patient`	`sourcePatientInfoTarget` The actual object that is the target of the reference (The Patient Information as known when the document was published.

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

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

Constructor Summary

Constructors
Constructor and Description

DocumentReferenceContextComponent()
Constructor

Constructors
Constructor and Description
`DocumentReferenceContextComponent()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`CodeableConcept`	`addEvent()`
`DocumentReference.DocumentReferenceContextComponent`	`addEvent(CodeableConcept t)`
`DocumentReference.DocumentReferenceContextRelatedComponent`	`addRelated()`
`DocumentReference.DocumentReferenceContextComponent`	`addRelated(DocumentReference.DocumentReferenceContextRelatedComponent t)`
`DocumentReference.DocumentReferenceContextComponent`	`copy()`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<CodeableConcept>`	`getEvent()`
`CodeableConcept`	`getEventFirstRep()`
`CodeableConcept`	`getFacilityType()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Period`	`getPeriod()`
`CodeableConcept`	`getPracticeSetting()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`List<DocumentReference.DocumentReferenceContextRelatedComponent>`	`getRelated()`
`DocumentReference.DocumentReferenceContextRelatedComponent`	`getRelatedFirstRep()`
`Reference`	`getSourcePatientInfo()`
`Patient`	`getSourcePatientInfoTarget()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasEncounter()`
`boolean`	`hasEvent()`
`boolean`	`hasFacilityType()`
`boolean`	`hasPeriod()`
`boolean`	`hasPracticeSetting()`
`boolean`	`hasRelated()`
`boolean`	`hasSourcePatientInfo()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`DocumentReference.DocumentReferenceContextComponent`	`setEncounter(Reference value)`
`DocumentReference.DocumentReferenceContextComponent`	`setEncounterTarget(Encounter value)`
`DocumentReference.DocumentReferenceContextComponent`	`setEvent(List<CodeableConcept> theEvent)`
`DocumentReference.DocumentReferenceContextComponent`	`setFacilityType(CodeableConcept value)`
`DocumentReference.DocumentReferenceContextComponent`	`setPeriod(Period value)`
`DocumentReference.DocumentReferenceContextComponent`	`setPracticeSetting(CodeableConcept value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`DocumentReference.DocumentReferenceContextComponent`	`setRelated(List<DocumentReference.DocumentReferenceContextRelatedComponent> theRelated)`
`DocumentReference.DocumentReferenceContextComponent`	`setSourcePatientInfo(Reference value)`
`DocumentReference.DocumentReferenceContextComponent`	`setSourcePatientInfoTarget(Patient value)`

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

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

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, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, 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, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
  - encounter
```
protected Reference encounter
```
    Describes the clinical encounter or type of care that the document content 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 that the document content is associated with.)
  - event
```
protected List<CodeableConcept> event
```
    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 type code, 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 time period over which the service that is described by the document was provided.
  - facilityType
```
protected CodeableConcept facilityType
```
    The kind of facility where the patient was seen.
  - practiceSetting
```
protected CodeableConcept practiceSetting
```
    This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
  - sourcePatientInfo
```
protected Reference sourcePatientInfo
```
    The Patient Information as known when the document was published. May be a reference to a version specific, or contained.
  - sourcePatientInfoTarget
```
protected Patient sourcePatientInfoTarget
```
    The actual object that is the target of the reference (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
  - related
```
protected List<DocumentReference.DocumentReferenceContextRelatedComponent> related
```
    Related identifiers or resources associated with the DocumentReference.
- Constructor Detail
  - DocumentReferenceContextComponent
```
public DocumentReferenceContextComponent()
```
    Constructor
- Method Detail
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (Describes the clinical encounter or type of care that the document content is associated with.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public DocumentReference.DocumentReferenceContextComponent setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (Describes the clinical encounter or type of care that the document content 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 that the document content is associated with.)
  - setEncounterTarget
```
public DocumentReference.DocumentReferenceContextComponent 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 that the document content is associated with.)
  - getEvent
```
public List<CodeableConcept> getEvent()
```
    Returns:
    
    event (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 type code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.)
  - setEvent
```
public DocumentReference.DocumentReferenceContextComponent setEvent(List<CodeableConcept> theEvent)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasEvent
```
public boolean hasEvent()
```
  - addEvent
```
public CodeableConcept addEvent()
```
  - addEvent
```
public DocumentReference.DocumentReferenceContextComponent addEvent(CodeableConcept t)
```
  - getEventFirstRep
```
public CodeableConcept getEventFirstRep()
```
    Returns:
    
    The first repetition of repeating field event, creating it if it does not already exist
  - getPeriod
```
public Period getPeriod()
```
    Returns:
    
    period (The time period over which the service that is described by the document was provided.)
  - hasPeriod
```
public boolean hasPeriod()
```
  - setPeriod
```
public DocumentReference.DocumentReferenceContextComponent setPeriod(Period value)
```
    Parameters:
    
    value - period (The time period over which the service that is described by the document was provided.)
  - getFacilityType
```
public CodeableConcept getFacilityType()
```
    Returns:
    
    facilityType (The kind of facility where the patient was seen.)
  - hasFacilityType
```
public boolean hasFacilityType()
```
  - setFacilityType
```
public DocumentReference.DocumentReferenceContextComponent setFacilityType(CodeableConcept value)
```
    Parameters:
    
    value - facilityType (The kind of facility where the patient was seen.)
  - getPracticeSetting
```
public CodeableConcept getPracticeSetting()
```
    Returns:
    
    practiceSetting (This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.)
  - hasPracticeSetting
```
public boolean hasPracticeSetting()
```
  - setPracticeSetting
```
public DocumentReference.DocumentReferenceContextComponent setPracticeSetting(CodeableConcept value)
```
    Parameters:
    
    value - practiceSetting (This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.)
  - getSourcePatientInfo
```
public Reference getSourcePatientInfo()
```
    Returns:
    
    sourcePatientInfo (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
  - hasSourcePatientInfo
```
public boolean hasSourcePatientInfo()
```
  - setSourcePatientInfo
```
public DocumentReference.DocumentReferenceContextComponent setSourcePatientInfo(Reference value)
```
    Parameters:
    
    value - sourcePatientInfo (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
  - getSourcePatientInfoTarget
```
public Patient getSourcePatientInfoTarget()
```
    Returns:
    
    sourcePatientInfo 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. (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
  - setSourcePatientInfoTarget
```
public DocumentReference.DocumentReferenceContextComponent setSourcePatientInfoTarget(Patient value)
```
    Parameters:
    
    value - sourcePatientInfo 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. (The Patient Information as known when the document was published. May be a reference to a version specific, or contained.)
  - getRelated
```
public List<DocumentReference.DocumentReferenceContextRelatedComponent> getRelated()
```
    Returns:
    
    related (Related identifiers or resources associated with the DocumentReference.)
  - setRelated
```
public DocumentReference.DocumentReferenceContextComponent setRelated(List<DocumentReference.DocumentReferenceContextRelatedComponent> theRelated)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasRelated
```
public boolean hasRelated()
```
  - addRelated
```
public DocumentReference.DocumentReferenceContextRelatedComponent addRelated()
```
  - addRelated
```
public DocumentReference.DocumentReferenceContextComponent addRelated(DocumentReference.DocumentReferenceContextRelatedComponent t)
```
  - getRelatedFirstRep
```
public DocumentReference.DocumentReferenceContextRelatedComponent getRelatedFirstRep()
```
    Returns:
    
    The first repetition of repeating field related, creating it if it does not already exist
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class BackboneElement
    
    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 BackboneElement
    
    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 BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - copy
```
public DocumentReference.DocumentReferenceContextComponent 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 org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Overrides:
    
    fhirType in class BackboneElement

Class DocumentReference.DocumentReferenceContextComponent

Field Summary

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

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

Constructor Summary

Method Summary

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

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

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.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

encounter

encounterTarget

event

period

facilityType

practiceSetting

sourcePatientInfo

sourcePatientInfoTarget

related

Constructor Detail

DocumentReferenceContextComponent

Method Detail

getEncounter

hasEncounter

setEncounter

getEncounterTarget

setEncounterTarget

getEvent

setEvent

hasEvent

addEvent

addEvent

getEventFirstRep

getPeriod

hasPeriod

setPeriod

getFacilityType

hasFacilityType

setFacilityType

getPracticeSetting

hasPracticeSetting

setPracticeSetting

getSourcePatientInfo

hasSourcePatientInfo

setSourcePatientInfo

getSourcePatientInfoTarget

setSourcePatientInfoTarget

getRelated

setRelated

hasRelated

addRelated

addRelated

getRelatedFirstRep

listChildren

getNamedProperty

getProperty

setProperty

setProperty

makeProperty

getTypesForProperty

addChild

copy

equalsDeep

equalsShallow

isEmpty

fhirType