SupportingDocumentation (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.SupportingDocumentation

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class SupportingDocumentation
extends BaseResource
implements IResource
```
HAPI/FHIR SupportingDocumentation Resource ()
Definition: This resource provides the supporting information for a process, for example clinical or financial information related to a claim or pre-authorization.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/SupportingDocumentation

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SupportingDocumentation.Detail
Block class for child element: SupportingDocumentation.detail ()

Nested Classes
Modifier and Type	Class and Description
`static class`	`SupportingDocumentation.Detail` Block class for child element: SupportingDocumentation.detail ()

Field Summary

Fields
Modifier and Type	Field and Description
`static ReferenceClientParam`	`AUTHOR` Fluent Client search parameter constant for author
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_AUTHOR` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_AUTHOR` Search parameter constant for author
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
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

SupportingDocumentation()

Constructors
Constructor and Description
`SupportingDocumentation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SupportingDocumentation.Detail`	`addDetail()` Adds and returns a new value for detail ()
`SupportingDocumentation`	`addDetail(SupportingDocumentation.Detail theValue)` Adds a given new value for detail ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`SupportingDocumentation`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ResourceReferenceDt`	`getAuthor()` Gets the value(s) for author ().
`Date`	`getCreated()` Gets the value(s) for created ().
`DateTimeDt`	`getCreatedElement()` Gets the value(s) for created ().
`List<SupportingDocumentation.Detail>`	`getDetail()` Gets the value(s) for detail ().
`SupportingDocumentation.Detail`	`getDetailFirstRep()` Gets the first repetition for detail (), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier ().
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (), creating it if it does not already exist.
`ResourceReferenceDt`	`getOrganization()` Gets the value(s) for organization ().
`CodingDt`	`getOriginalRuleset()` Gets the value(s) for originalRuleset ().
`ResourceReferenceDt`	`getProvider()` Gets the value(s) for provider ().
`ResourceReferenceDt`	`getRequest()` Gets the value(s) for request ().
`String`	`getResourceName()`
`ResourceReferenceDt`	`getResponse()` Gets the value(s) for response ().
`CodingDt`	`getRuleset()` Gets the value(s) for ruleset ().
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject ().
`ResourceReferenceDt`	`getTarget()` Gets the value(s) for target ().
`boolean`	`isEmpty()`
`SupportingDocumentation`	`setAuthor(ResourceReferenceDt theValue)` Sets the value(s) for author ()
`SupportingDocumentation`	`setCreated(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for created ()
`SupportingDocumentation`	`setCreated(DateTimeDt theValue)` Sets the value(s) for created ()
`SupportingDocumentation`	`setCreatedWithSecondsPrecision(Date theDate)` Sets the value for created ()
`SupportingDocumentation`	`setDetail(List<SupportingDocumentation.Detail> theValue)` Sets the value(s) for detail ()
`SupportingDocumentation`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`SupportingDocumentation`	`setOrganization(ResourceReferenceDt theValue)` Sets the value(s) for organization ()
`SupportingDocumentation`	`setOriginalRuleset(CodingDt theValue)` Sets the value(s) for originalRuleset ()
`SupportingDocumentation`	`setProvider(ResourceReferenceDt theValue)` Sets the value(s) for provider ()
`SupportingDocumentation`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request ()
`SupportingDocumentation`	`setResponse(ResourceReferenceDt theValue)` Sets the value(s) for response ()
`SupportingDocumentation`	`setRuleset(CodingDt theValue)` Sets the value(s) for ruleset ()
`SupportingDocumentation`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject ()
`SupportingDocumentation`	`setTarget(ResourceReferenceDt theValue)` Sets the value(s) for target ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: The business identifier of the Eligibility
    Type: token
    Path: SupportingDocumentation.identifier
    
    See Also:
    
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: The business identifier of the Eligibility
    Type: token
    Path: SupportingDocumentation.identifier
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description: The person who generated this resource
    Type: reference
    Path: SupportingDocumentation.author
    
    See Also:
    
    Constant Field Values
  - AUTHOR
```
public static final ReferenceClientParam AUTHOR
```
    Fluent Client search parameter constant for author
    Description: The person who generated this resource
    Type: reference
    Path: SupportingDocumentation.author
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The patient to whom the documents refer
    Type: reference
    Path: SupportingDocumentation.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The patient to whom the documents refer
    Type: reference
    Path: SupportingDocumentation.subject
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: The patient to whom the documents refer
    Type: reference
    Path: SupportingDocumentation.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: The patient to whom the documents refer
    Type: reference
    Path: SupportingDocumentation.subject
  - INCLUDE_AUTHOR
```
public static final Include INCLUDE_AUTHOR
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupportingDocumentation:author".
  - INCLUDE_PATIENT
```
public static final Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupportingDocumentation:patient".
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "SupportingDocumentation:subject".
- Constructor Detail
  - SupportingDocumentation
```
public SupportingDocumentation()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.
    Definition: The Response business identifier
  - setIdentifier
```
public SupportingDocumentation setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier ()
    Definition: The Response business identifier
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier ()
    Definition: The Response business identifier
  - addIdentifier
```
public SupportingDocumentation addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier ()
    Definition: The Response business identifier
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (), creating it if it does not already exist.
    Definition: The Response business identifier
  - getRuleset
```
public CodingDt getRuleset()
```
    Gets the value(s) for ruleset (). creating it if it does not exist. Will not return null.
    Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - setRuleset
```
public SupportingDocumentation setRuleset(CodingDt theValue)
```
    Sets the value(s) for ruleset ()
    Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.
  - getOriginalRuleset
```
public CodingDt getOriginalRuleset()
```
    Gets the value(s) for originalRuleset (). creating it if it does not exist. Will not return null.
    Definition: The style (standard) and version of the original material which was converted into this resource.
  - setOriginalRuleset
```
public SupportingDocumentation setOriginalRuleset(CodingDt theValue)
```
    Sets the value(s) for originalRuleset ()
    Definition: The style (standard) and version of the original material which was converted into this resource.
  - getCreatedElement
```
public DateTimeDt getCreatedElement()
```
    Gets the value(s) for created (). creating it if it does not exist. Will not return null.
    Definition: The date when this resource was created.
  - getCreated
```
public Date getCreated()
```
    Gets the value(s) for created (). creating it if it does not exist. Will not return null.
    Definition: The date when this resource was created.
  - setCreated
```
public SupportingDocumentation setCreated(DateTimeDt theValue)
```
    Sets the value(s) for created ()
    Definition: The date when this resource was created.
  - setCreated
```
public SupportingDocumentation setCreated(Date theDate,
                                          TemporalPrecisionEnum thePrecision)
```
    Sets the value for created ()
    Definition: The date when this resource was created.
  - setCreatedWithSecondsPrecision
```
public SupportingDocumentation setCreatedWithSecondsPrecision(Date theDate)
```
    Sets the value for created ()
    Definition: The date when this resource was created.
  - getTarget
```
public ResourceReferenceDt getTarget()
```
    Gets the value(s) for target (). creating it if it does not exist. Will not return null.
    Definition: The Insurer, organization or Provider who is target of the submission.
  - setTarget
```
public SupportingDocumentation setTarget(ResourceReferenceDt theValue)
```
    Sets the value(s) for target ()
    Definition: The Insurer, organization or Provider who is target of the submission.
  - getProvider
```
public ResourceReferenceDt getProvider()
```
    Gets the value(s) for provider (). creating it if it does not exist. Will not return null.
    Definition: The practitioner who is responsible for the services rendered to the patient.
  - setProvider
```
public SupportingDocumentation setProvider(ResourceReferenceDt theValue)
```
    Sets the value(s) for provider ()
    Definition: The practitioner who is responsible for the services rendered to the patient.
  - getOrganization
```
public ResourceReferenceDt getOrganization()
```
    Gets the value(s) for organization (). creating it if it does not exist. Will not return null.
    Definition: The organization which is responsible for the services rendered to the patient.
  - setOrganization
```
public SupportingDocumentation setOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for organization ()
    Definition: The organization which is responsible for the services rendered to the patient.
  - getRequest
```
public ResourceReferenceDt getRequest()
```
    Gets the value(s) for request (). creating it if it does not exist. Will not return null.
    Definition: Original request
  - setRequest
```
public SupportingDocumentation setRequest(ResourceReferenceDt theValue)
```
    Sets the value(s) for request ()
    Definition: Original request
  - getResponse
```
public ResourceReferenceDt getResponse()
```
    Gets the value(s) for response (). creating it if it does not exist. Will not return null.
    Definition: Original response
  - setResponse
```
public SupportingDocumentation setResponse(ResourceReferenceDt theValue)
```
    Sets the value(s) for response ()
    Definition: Original response
  - getAuthor
```
public ResourceReferenceDt getAuthor()
```
    Gets the value(s) for author (). creating it if it does not exist. Will not return null.
    Definition: Person who created the submission
  - setAuthor
```
public SupportingDocumentation setAuthor(ResourceReferenceDt theValue)
```
    Sets the value(s) for author ()
    Definition: Person who created the submission
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (). creating it if it does not exist. Will not return null.
    Definition: The patient who is directly or indirectly the subject of the supporting information.
  - setSubject
```
public SupportingDocumentation setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject ()
    Definition: The patient who is directly or indirectly the subject of the supporting information.
  - getDetail
```
public List<SupportingDocumentation.Detail> getDetail()
```
    Gets the value(s) for detail (). creating it if it does not exist. Will not return null.
    Definition:
  - setDetail
```
public SupportingDocumentation setDetail(List<SupportingDocumentation.Detail> theValue)
```
    Sets the value(s) for detail ()
    Definition:
  - addDetail
```
public SupportingDocumentation.Detail addDetail()
```
    Adds and returns a new value for detail ()
    Definition:
  - addDetail
```
public SupportingDocumentation addDetail(SupportingDocumentation.Detail theValue)
```
    Adds a given new value for detail ()
    Definition:
    
    Parameters:
    
    theValue - The detail to add (must not be null)
  - getDetailFirstRep
```
public SupportingDocumentation.Detail getDetailFirstRep()
```
    Gets the first repetition for detail (), creating it if it does not already exist.
    Definition:
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface IResource
  - getStructureFhirVersionEnum
```
public FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface IBaseResource

Class SupportingDocumentation

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_IDENTIFIER

IDENTIFIER

SP_AUTHOR

AUTHOR

SP_SUBJECT

SUBJECT

SP_PATIENT

PATIENT

INCLUDE_AUTHOR

INCLUDE_PATIENT

INCLUDE_SUBJECT

Constructor Detail

SupportingDocumentation

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getRuleset

setRuleset

getOriginalRuleset

setOriginalRuleset

getCreatedElement

getCreated

setCreated

setCreated

setCreatedWithSecondsPrecision

getTarget

setTarget

getProvider

setProvider

getOrganization

setOrganization

getRequest

setRequest

getResponse

setResponse

getAuthor

setAuthor

getSubject

setSubject

getDetail

setDetail

addDetail

addDetail

getDetailFirstRep

getResourceName

getStructureFhirVersionEnum