Organization (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Organization

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Organization
extends BaseResource
implements IResource
```
HAPI/FHIR Organization Resource (A grouping of people or organizations with a common purpose)
Definition: A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc

Requirements:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Organization.Contact` Block class for child element: Organization.contact (Contact for the organization for a certain purpose)

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`static TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static Include`	`INCLUDE_PARTOF` Constant for fluent queries to be used to add include statements.
`static StringClientParam`	`NAME` Fluent Client search parameter constant for name
`static ReferenceClientParam`	`PARTOF` Fluent Client search parameter constant for partof
`static StringClientParam`	`PHONETIC` Fluent Client search parameter constant for phonetic
`static String`	`SP_ACTIVE` Search parameter constant for active
`static String`	`SP_IDENTIFIER` Search parameter constant for identifier
`static String`	`SP_NAME` Search parameter constant for name
`static String`	`SP_PARTOF` Search parameter constant for partof
`static String`	`SP_PHONETIC` Search parameter constant for phonetic
`static String`	`SP_TYPE` Search parameter constant for type
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Organization()

Constructors
Constructor and Description
`Organization()`

Method Summary

Methods
Modifier and Type	Method and Description
`AddressDt`	`addAddress()` Adds and returns a new value for address (An address for the organization)
`Organization.Contact`	`addContact()` Adds and returns a new value for contact (Contact for the organization for a certain purpose)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (Identifies this organization across multiple systems)
`Organization`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (Identifies this organization across multiple systems)
`Organization`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (Identifies this organization across multiple systems)
`ResourceReferenceDt`	`addLocation()` Adds and returns a new value for location (Location(s) the organization uses to provide services)
`ContactDt`	`addTelecom()` Adds and returns a new value for telecom (A contact detail for the organization)
`Organization`	`addTelecom(ContactUseEnum theContactUse, String theValue)` Adds a new value for telecom (A contact detail for the organization)
`Organization`	`addTelecom(String theValue)` Adds a new value for telecom (A contact detail for the organization)
`BooleanDt`	`getActive()` Gets the value(s) for active (Whether the organization's record is still in active use).
`List<AddressDt>`	`getAddress()` Gets the value(s) for address (An address for the organization).
`AddressDt`	`getAddressFirstRep()` Gets the first repetition for address (An address for the organization), creating it if it does not already exist.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`List<Organization.Contact>`	`getContact()` Gets the value(s) for contact (Contact for the organization for a certain purpose).
`Organization.Contact`	`getContactFirstRep()` Gets the first repetition for contact (Contact for the organization for a certain purpose), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (Identifies this organization across multiple systems).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (Identifies this organization across multiple systems), creating it if it does not already exist.
`List<ResourceReferenceDt>`	`getLocation()` Gets the value(s) for location (Location(s) the organization uses to provide services).
`StringDt`	`getName()` Gets the value(s) for name (Name used for the organization).
`ResourceReferenceDt`	`getPartOf()` Gets the value(s) for partOf (The organization of which this organization forms a part).
`List<ContactDt>`	`getTelecom()` Gets the value(s) for telecom (A contact detail for the organization).
`ContactDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (A contact detail for the organization), creating it if it does not already exist.
`BoundCodeableConceptDt<OrganizationTypeEnum>`	`getType()` Gets the value(s) for type (Kind of organization).
`boolean`	`isEmpty()`
`Organization`	`setActive(boolean theBoolean)` Sets the value for active (Whether the organization's record is still in active use)
`Organization`	`setActive(BooleanDt theValue)` Sets the value(s) for active (Whether the organization's record is still in active use)
`Organization`	`setAddress(List<AddressDt> theValue)` Sets the value(s) for address (An address for the organization)
`Organization`	`setContact(List<Organization.Contact> theValue)` Sets the value(s) for contact (Contact for the organization for a certain purpose)
`Organization`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (Identifies this organization across multiple systems)
`Organization`	`setLocation(List<ResourceReferenceDt> theValue)` Sets the value(s) for location (Location(s) the organization uses to provide services)
`Organization`	`setName(String theString)` Sets the value for name (Name used for the organization)
`Organization`	`setName(StringDt theValue)` Sets the value(s) for name (Name used for the organization)
`Organization`	`setPartOf(ResourceReferenceDt theValue)` Sets the value(s) for partOf (The organization of which this organization forms a part)
`Organization`	`setTelecom(List<ContactDt> theValue)` Sets the value(s) for telecom (A contact detail for the organization)
`Organization`	`setType(BoundCodeableConceptDt<OrganizationTypeEnum> theValue)` Sets the value(s) for type (Kind of organization)
`Organization`	`setType(OrganizationTypeEnum theValue)` Sets the value(s) for type (Kind of organization)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, 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

- Field Detail
  - SP_NAME
```
public static final String SP_NAME
```
    Search parameter constant for name
    Description: A portion of the organization's name
    Type: string
    Path: Organization.name
    
    See Also:
    Constant Field Values
  - NAME
```
public static final StringClientParam NAME
```
    Fluent Client search parameter constant for name
    Description: A portion of the organization's name
    Type: string
    Path: Organization.name
  - SP_PHONETIC
```
public static final String SP_PHONETIC
```
    Search parameter constant for phonetic
    Description: A portion of the organization's name using some kind of phonetic matching algorithm
    Type: string
    Path:
    
    See Also:
    Constant Field Values
  - PHONETIC
```
public static final StringClientParam PHONETIC
```
    Fluent Client search parameter constant for phonetic
    Description: A portion of the organization's name using some kind of phonetic matching algorithm
    Type: string
    Path:
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description: A code for the type of organization
    Type: token
    Path: Organization.type
    
    See Also:
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: A code for the type of organization
    Type: token
    Path: Organization.type
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter constant for identifier
    Description: Any identifier for the organization (not the accreditation issuer's identifier)
    Type: token
    Path: Organization.identifier
    
    See Also:
    Constant Field Values
  - IDENTIFIER
```
public static final TokenClientParam IDENTIFIER
```
    Fluent Client search parameter constant for identifier
    Description: Any identifier for the organization (not the accreditation issuer's identifier)
    Type: token
    Path: Organization.identifier
  - SP_PARTOF
```
public static final String SP_PARTOF
```
    Search parameter constant for partof
    Description: Search all organizations that are part of the given organization
    Type: reference
    Path: Organization.partOf
    
    See Also:
    Constant Field Values
  - PARTOF
```
public static final ReferenceClientParam PARTOF
```
    Fluent Client search parameter constant for partof
    Description: Search all organizations that are part of the given organization
    Type: reference
    Path: Organization.partOf
  - INCLUDE_PARTOF
```
public static final Include INCLUDE_PARTOF
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Organization.partOf".
  - SP_ACTIVE
```
public static final String SP_ACTIVE
```
    Search parameter constant for active
    Description: Whether the organization's record is active
    Type: token
    Path: Organization.active
    
    See Also:
    Constant Field Values
  - ACTIVE
```
public static final TokenClientParam ACTIVE
```
    Fluent Client search parameter constant for active
    Description: Whether the organization's record is active
    Type: token
    Path: Organization.active
- Constructor Detail
  - Organization
```
public Organization()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (Identifies this organization across multiple systems). creating it if it does not exist. Will not return null.
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
  - setIdentifier
```
public Organization setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (Identifies this organization across multiple systems)
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (Identifies this organization across multiple systems)
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (Identifies this organization across multiple systems), creating it if it does not already exist.
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
  - addIdentifier
```
public Organization addIdentifier(IdentifierUseEnum theUse,
                         String theSystem,
                         String theValue,
                         String theLabel)
```
    Adds a new value for identifier (Identifies this organization across multiple systems)
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Organization addIdentifier(String theSystem,
                         String theValue)
```
    Adds a new value for identifier (Identifies this organization across multiple systems)
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getName
```
public StringDt getName()
```
    Gets the value(s) for name (Name used for the organization). creating it if it does not exist. Will not return null.
    Definition: A name associated with the organization
  - setName
```
public Organization setName(StringDt theValue)
```
    Sets the value(s) for name (Name used for the organization)
    Definition: A name associated with the organization
  - setName
```
public Organization setName(String theString)
```
    Sets the value for name (Name used for the organization)
    Definition: A name associated with the organization
  - getType
```
public BoundCodeableConceptDt<OrganizationTypeEnum> getType()
```
    Gets the value(s) for type (Kind of organization). creating it if it does not exist. Will not return null.
    Definition: The kind of organization that this is
  - setType
```
public Organization setType(BoundCodeableConceptDt<OrganizationTypeEnum> theValue)
```
    Sets the value(s) for type (Kind of organization)
    Definition: The kind of organization that this is
  - setType
```
public Organization setType(OrganizationTypeEnum theValue)
```
    Sets the value(s) for type (Kind of organization)
    Definition: The kind of organization that this is
  - getTelecom
```
public List<ContactDt> getTelecom()
```
    Gets the value(s) for telecom (A contact detail for the organization). creating it if it does not exist. Will not return null.
    Definition: A contact detail for the organization
  - setTelecom
```
public Organization setTelecom(List<ContactDt> theValue)
```
    Sets the value(s) for telecom (A contact detail for the organization)
    Definition: A contact detail for the organization
  - addTelecom
```
public ContactDt addTelecom()
```
    Adds and returns a new value for telecom (A contact detail for the organization)
    Definition: A contact detail for the organization
  - getTelecomFirstRep
```
public ContactDt getTelecomFirstRep()
```
    Gets the first repetition for telecom (A contact detail for the organization), creating it if it does not already exist.
    Definition: A contact detail for the organization
  - addTelecom
```
public Organization addTelecom(ContactUseEnum theContactUse,
                      String theValue)
```
    Adds a new value for telecom (A contact detail for the organization)
    Definition: A contact detail for the organization
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addTelecom
```
public Organization addTelecom(String theValue)
```
    Adds a new value for telecom (A contact detail for the organization)
    Definition: A contact detail for the organization
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getAddress
```
public List<AddressDt> getAddress()
```
    Gets the value(s) for address (An address for the organization). creating it if it does not exist. Will not return null.
    Definition: An address for the organization
  - setAddress
```
public Organization setAddress(List<AddressDt> theValue)
```
    Sets the value(s) for address (An address for the organization)
    Definition: An address for the organization
  - addAddress
```
public AddressDt addAddress()
```
    Adds and returns a new value for address (An address for the organization)
    Definition: An address for the organization
  - getAddressFirstRep
```
public AddressDt getAddressFirstRep()
```
    Gets the first repetition for address (An address for the organization), creating it if it does not already exist.
    Definition: An address for the organization
  - getPartOf
```
public ResourceReferenceDt getPartOf()
```
    Gets the value(s) for partOf (The organization of which this organization forms a part). creating it if it does not exist. Will not return null.
    Definition: The organization of which this organization forms a part
  - setPartOf
```
public Organization setPartOf(ResourceReferenceDt theValue)
```
    Sets the value(s) for partOf (The organization of which this organization forms a part)
    Definition: The organization of which this organization forms a part
  - getContact
```
public List<Organization.Contact> getContact()
```
    Gets the value(s) for contact (Contact for the organization for a certain purpose). creating it if it does not exist. Will not return null.
    Definition:
  - setContact
```
public Organization setContact(List<Organization.Contact> theValue)
```
    Sets the value(s) for contact (Contact for the organization for a certain purpose)
    Definition:
  - addContact
```
public Organization.Contact addContact()
```
    Adds and returns a new value for contact (Contact for the organization for a certain purpose)
    Definition:
  - getContactFirstRep
```
public Organization.Contact getContactFirstRep()
```
    Gets the first repetition for contact (Contact for the organization for a certain purpose), creating it if it does not already exist.
    Definition:
  - getLocation
```
public List<ResourceReferenceDt> getLocation()
```
    Gets the value(s) for location (Location(s) the organization uses to provide services). creating it if it does not exist. Will not return null.
    Definition: Location(s) the organization uses to provide services
  - setLocation
```
public Organization setLocation(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for location (Location(s) the organization uses to provide services)
    Definition: Location(s) the organization uses to provide services
  - addLocation
```
public ResourceReferenceDt addLocation()
```
    Adds and returns a new value for location (Location(s) the organization uses to provide services)
    Definition: Location(s) the organization uses to provide services
  - getActive
```
public BooleanDt getActive()
```
    Gets the value(s) for active (Whether the organization's record is still in active use). creating it if it does not exist. Will not return null.
    Definition: Whether the organization's record is still in active use
  - setActive
```
public Organization setActive(BooleanDt theValue)
```
    Sets the value(s) for active (Whether the organization's record is still in active use)
    Definition: Whether the organization's record is still in active use
  - setActive
```
public Organization setActive(boolean theBoolean)
```
    Sets the value for active (Whether the organization's record is still in active use)
    Definition: Whether the organization's record is still in active use

Class Organization

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.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

Field Detail

SP_NAME

NAME

SP_PHONETIC

PHONETIC

SP_TYPE

TYPE

SP_IDENTIFIER

IDENTIFIER

SP_PARTOF

PARTOF

INCLUDE_PARTOF

SP_ACTIVE

ACTIVE

Constructor Detail

Organization

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getName

setName

setName

getType

setType

setType

getTelecom

setTelecom

addTelecom

getTelecomFirstRep

addTelecom

addTelecom

getAddress

setAddress

addAddress

getAddressFirstRep

getPartOf

setPartOf

getContact

setContact

addContact

getContactFirstRep

getLocation

setLocation

addLocation

getActive

setActive

setActive