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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Documentation
extends BaseResource
implements IResource
```
HAPI/FHIR Documentation Resource ()
Definition: This resource provides the supporting information for an insurance related transaction such as a claim of pre-authorization.

Requirements:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`Documentation.Detail` Block class for child element: Documentation.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

Documentation()

Constructors
Constructor and Description
`Documentation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Documentation.Detail`	`addDetail()` Adds and returns a new value for detail ()
`Documentation`	`addDetail(Documentation.Detail theValue)` Adds a given new value for detail ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier ()
`Documentation`	`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`	`getDate()` Gets the value(s) for date ().
`DateDt`	`getDateElement()` Gets the value(s) for date ().
`List<Documentation.Detail>`	`getDetail()` Gets the value(s) for detail ().
`Documentation.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 ().
`IdentifierDt`	`getRequestIdentifier()` Gets the value(s) for requestIdentifier ().
`String`	`getResourceName()`
`ResourceReferenceDt`	`getResponse()` Gets the value(s) for response ().
`IdentifierDt`	`getResponseIdentifier()` Gets the value(s) for responseIdentifier ().
`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()`
`Documentation`	`setAuthor(ResourceReferenceDt theValue)` Sets the value(s) for author ()
`Documentation`	`setDate(DateDt theValue)` Sets the value(s) for date ()
`Documentation`	`setDate(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for date ()
`Documentation`	`setDateWithDayPrecision(Date theDate)` Sets the value for date ()
`Documentation`	`setDetail(List<Documentation.Detail> theValue)` Sets the value(s) for detail ()
`Documentation`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier ()
`Documentation`	`setOrganization(ResourceReferenceDt theValue)` Sets the value(s) for organization ()
`Documentation`	`setOriginalRuleset(CodingDt theValue)` Sets the value(s) for originalRuleset ()
`Documentation`	`setProvider(ResourceReferenceDt theValue)` Sets the value(s) for provider ()
`Documentation`	`setRequest(ResourceReferenceDt theValue)` Sets the value(s) for request ()
`Documentation`	`setRequestIdentifier(IdentifierDt theValue)` Sets the value(s) for requestIdentifier ()
`Documentation`	`setResponse(ResourceReferenceDt theValue)` Sets the value(s) for response ()
`Documentation`	`setResponseIdentifier(IdentifierDt theValue)` Sets the value(s) for responseIdentifier ()
`Documentation`	`setRuleset(CodingDt theValue)` Sets the value(s) for ruleset ()
`Documentation`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject ()
`Documentation`	`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: Documentation.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: Documentation.identifier
  - SP_AUTHOR
```
public static final String SP_AUTHOR
```
    Search parameter constant for author
    Description: The person who generated this resource
    Type: reference
    Path: Documentation.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: Documentation.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: Documentation.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: Documentation.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: Documentation.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: Documentation.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 "Documentation: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 "Documentation: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 "Documentation:subject".
- Constructor Detail
  - Documentation
```
public Documentation()
```
- 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 Documentation 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 Documentation 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 Documentation 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 Documentation 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.
  - getDateElement
```
public DateDt getDateElement()
```
    Gets the value(s) for date (). creating it if it does not exist. Will not return null.
    Definition: The date when this resource was created.
  - getDate
```
public Date getDate()
```
    Gets the value(s) for date (). creating it if it does not exist. Will not return null.
    Definition: The date when this resource was created.
  - setDate
```
public Documentation setDate(DateDt theValue)
```
    Sets the value(s) for date ()
    Definition: The date when this resource was created.
  - setDate
```
public Documentation setDate(Date theDate,
                             TemporalPrecisionEnum thePrecision)
```
    Sets the value for date ()
    Definition: The date when this resource was created.
  - setDateWithDayPrecision
```
public Documentation setDateWithDayPrecision(Date theDate)
```
    Sets the value for date ()
    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 Documentation 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 Documentation 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 Documentation setOrganization(ResourceReferenceDt theValue)
```
    Sets the value(s) for organization ()
    Definition: The organization which is responsible for the services rendered to the patient.
  - getRequestIdentifier
```
public IdentifierDt getRequestIdentifier()
```
    Gets the value(s) for requestIdentifier (). creating it if it does not exist. Will not return null.
    Definition: Original request identifier
  - setRequestIdentifier
```
public Documentation setRequestIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for requestIdentifier ()
    Definition: Original request identifier
  - getRequest
```
public ResourceReferenceDt getRequest()
```
    Gets the value(s) for request (). creating it if it does not exist. Will not return null.
    Definition: Original request identifier
  - setRequest
```
public Documentation setRequest(ResourceReferenceDt theValue)
```
    Sets the value(s) for request ()
    Definition: Original request identifier
  - getResponseIdentifier
```
public IdentifierDt getResponseIdentifier()
```
    Gets the value(s) for responseIdentifier (). creating it if it does not exist. Will not return null.
    Definition: Original response identifier
  - setResponseIdentifier
```
public Documentation setResponseIdentifier(IdentifierDt theValue)
```
    Sets the value(s) for responseIdentifier ()
    Definition: Original response identifier
  - getResponse
```
public ResourceReferenceDt getResponse()
```
    Gets the value(s) for response (). creating it if it does not exist. Will not return null.
    Definition: Original response identifier
  - setResponse
```
public Documentation setResponse(ResourceReferenceDt theValue)
```
    Sets the value(s) for response ()
    Definition: Original response identifier
  - 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 Documentation 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 Documentation 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<Documentation.Detail> getDetail()
```
    Gets the value(s) for detail (). creating it if it does not exist. Will not return null.
    Definition:
  - setDetail
```
public Documentation setDetail(List<Documentation.Detail> theValue)
```
    Sets the value(s) for detail ()
    Definition:
  - addDetail
```
public Documentation.Detail addDetail()
```
    Adds and returns a new value for detail ()
    Definition:
  - addDetail
```
public Documentation addDetail(Documentation.Detail theValue)
```
    Adds a given new value for detail ()
    Definition:
    
    Parameters:
    
    theValue - The detail to add (must not be null)
  - getDetailFirstRep
```
public Documentation.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 Documentation

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

Documentation

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getRuleset

setRuleset

getOriginalRuleset

setOriginalRuleset

getDateElement

getDate

setDate

setDate

setDateWithDayPrecision

getTarget

setTarget

getProvider

setProvider

getOrganization

setOrganization

getRequestIdentifier

setRequestIdentifier

getRequest

setRequest

getResponseIdentifier

setResponseIdentifier

getResponse

setResponse

getAuthor

setAuthor

getSubject

setSubject

getDetail

setDetail

addDetail

addDetail

getDetailFirstRep

getResourceName

getStructureFhirVersionEnum