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

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource
```
public class Organization
extends BaseResource
implements IResource
```
HAPI/FHIR Organization Resource (administrative.group)
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Organization.Contact
Block class for child element: Organization.contact ()

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

Field Summary

Fields
Modifier and Type	Field and Description
`static TokenClientParam`	`ACTIVE` Fluent Client search parameter constant for active
`static StringClientParam`	`ADDRESS` Fluent Client search parameter constant for address
`static StringClientParam`	`ADDRESS_CITY` Fluent Client search parameter constant for address-city
`static StringClientParam`	`ADDRESS_COUNTRY` Fluent Client search parameter constant for address-country
`static StringClientParam`	`ADDRESS_POSTALCODE` Fluent Client search parameter constant for address-postalcode
`static StringClientParam`	`ADDRESS_STATE` Fluent Client search parameter constant for address-state
`static TokenClientParam`	`ADDRESS_USE` Fluent Client search parameter constant for address-use
`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_ADDRESS` Search parameter constant for address
`static String`	`SP_ADDRESS_CITY` Search parameter constant for address-city
`static String`	`SP_ADDRESS_COUNTRY` Search parameter constant for address-country
`static String`	`SP_ADDRESS_POSTALCODE` Search parameter constant for address-postalcode
`static String`	`SP_ADDRESS_STATE` Search parameter constant for address-state
`static String`	`SP_ADDRESS_USE` Search parameter constant for address-use
`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.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

Organization()

Constructors
Constructor and Description
`Organization()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddressDt`	`addAddress()` Adds and returns a new value for address ()
`Organization`	`addAddress(AddressDt theValue)` Adds a given new value for address ()
`Organization.Contact`	`addContact()` Adds and returns a new value for contact ()
`Organization`	`addContact(Organization.Contact theValue)` Adds a given new value for contact ()
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`Organization`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`ContactPointDt`	`addTelecom()` Adds and returns a new value for telecom ()
`Organization`	`addTelecom(ContactPointDt theValue)` Adds a given new value for telecom ()
`Boolean`	`getActive()` Gets the value(s) for active (status).
`BooleanDt`	`getActiveElement()` Gets the value(s) for active (status).
`List<AddressDt>`	`getAddress()` Gets the value(s) for address ().
`AddressDt`	`getAddressFirstRep()` Gets the first repetition for address (), creating it if it does not already exist.
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`List<Organization.Contact>`	`getContact()` Gets the value(s) for contact ().
`Organization.Contact`	`getContactFirstRep()` Gets the first repetition for contact (), creating it if it does not already exist.
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`String`	`getName()` Gets the value(s) for name ().
`StringDt`	`getNameElement()` Gets the value(s) for name ().
`ResourceReferenceDt`	`getPartOf()` Gets the value(s) for partOf ().
`String`	`getResourceName()`
`FhirVersionEnum`	`getStructureFhirVersionEnum()`
`List<ContactPointDt>`	`getTelecom()` Gets the value(s) for telecom ().
`ContactPointDt`	`getTelecomFirstRep()` Gets the first repetition for telecom (), creating it if it does not already exist.
`BoundCodeableConceptDt<OrganizationTypeEnum>`	`getType()` Gets the value(s) for type (class).
`boolean`	`isEmpty()`
`Organization`	`setActive(boolean theBoolean)` Sets the value for active (status)
`Organization`	`setActive(BooleanDt theValue)` Sets the value(s) for active (status)
`Organization`	`setAddress(List<AddressDt> theValue)` Sets the value(s) for address ()
`Organization`	`setContact(List<Organization.Contact> theValue)` Sets the value(s) for contact ()
`Organization`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`Organization`	`setName(String theString)` Sets the value for name ()
`Organization`	`setName(StringDt theValue)` Sets the value(s) for name ()
`Organization`	`setPartOf(ResourceReferenceDt theValue)` Sets the value(s) for partOf ()
`Organization`	`setTelecom(List<ContactPointDt> theValue)` Sets the value(s) for telecom ()
`Organization`	`setType(BoundCodeableConceptDt<OrganizationTypeEnum> theValue)` Sets the value(s) for type (class)
`Organization`	`setType(OrganizationTypeEnum theValue)` Sets the value(s) for type (class)

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_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: Organization.name
    
    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: Organization.name
  - 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
  - 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
  - SP_ADDRESS
```
public static final String SP_ADDRESS
```
    Search parameter constant for address
    Description: A (part of the) address of the Organization
    Type: string
    Path: Organization.address
    
    See Also:
    
    Constant Field Values
  - ADDRESS
```
public static final StringClientParam ADDRESS
```
    Fluent Client search parameter constant for address
    Description: A (part of the) address of the Organization
    Type: string
    Path: Organization.address
  - SP_ADDRESS_CITY
```
public static final String SP_ADDRESS_CITY
```
    Search parameter constant for address-city
    Description: A city specified in an address
    Type: string
    Path: Organization.address.city
    
    See Also:
    
    Constant Field Values
  - ADDRESS_CITY
```
public static final StringClientParam ADDRESS_CITY
```
    Fluent Client search parameter constant for address-city
    Description: A city specified in an address
    Type: string
    Path: Organization.address.city
  - SP_ADDRESS_STATE
```
public static final String SP_ADDRESS_STATE
```
    Search parameter constant for address-state
    Description: A state specified in an address
    Type: string
    Path: Organization.address.state
    
    See Also:
    
    Constant Field Values
  - ADDRESS_STATE
```
public static final StringClientParam ADDRESS_STATE
```
    Fluent Client search parameter constant for address-state
    Description: A state specified in an address
    Type: string
    Path: Organization.address.state
  - SP_ADDRESS_POSTALCODE
```
public static final String SP_ADDRESS_POSTALCODE
```
    Search parameter constant for address-postalcode
    Description: A postal code specified in an address
    Type: string
    Path: Organization.address.postalCode
    
    See Also:
    
    Constant Field Values
  - ADDRESS_POSTALCODE
```
public static final StringClientParam ADDRESS_POSTALCODE
```
    Fluent Client search parameter constant for address-postalcode
    Description: A postal code specified in an address
    Type: string
    Path: Organization.address.postalCode
  - SP_ADDRESS_COUNTRY
```
public static final String SP_ADDRESS_COUNTRY
```
    Search parameter constant for address-country
    Description: A country specified in an address
    Type: string
    Path: Organization.address.country
    
    See Also:
    
    Constant Field Values
  - ADDRESS_COUNTRY
```
public static final StringClientParam ADDRESS_COUNTRY
```
    Fluent Client search parameter constant for address-country
    Description: A country specified in an address
    Type: string
    Path: Organization.address.country
  - SP_ADDRESS_USE
```
public static final String SP_ADDRESS_USE
```
    Search parameter constant for address-use
    Description: A use code specified in an address
    Type: token
    Path: Organization.address.use
    
    See Also:
    
    Constant Field Values
  - ADDRESS_USE
```
public static final TokenClientParam ADDRESS_USE
```
    Fluent Client search parameter constant for address-use
    Description: A use code specified in an address
    Type: token
    Path: Organization.address.use
  - 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".
- Constructor Detail
  - Organization
```
public Organization()
```
- 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 (id). 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 (id)
    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 (id)
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
  - addIdentifier
```
public Organization addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems
  - getActiveElement
```
public BooleanDt getActiveElement()
```
    Gets the value(s) for active (status). creating it if it does not exist. Will not return null.
    Definition: Whether the organization's record is still in active use
  - getActive
```
public Boolean getActive()
```
    Gets the value(s) for active (status). 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 (status)
    Definition: Whether the organization's record is still in active use
  - setActive
```
public Organization setActive(boolean theBoolean)
```
    Sets the value for active (status)
    Definition: Whether the organization's record is still in active use
  - getType
```
public BoundCodeableConceptDt<OrganizationTypeEnum> getType()
```
    Gets the value(s) for type (class). 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 (class)
    Definition: The kind of organization that this is
  - setType
```
public Organization setType(OrganizationTypeEnum theValue)
```
    Sets the value(s) for type (class)
    Definition: The kind of organization that this is
  - getNameElement
```
public StringDt getNameElement()
```
    Gets the value(s) for name (). creating it if it does not exist. Will not return null.
    Definition: A name associated with the organization
  - getName
```
public String getName()
```
    Gets the value(s) for name (). 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 ()
    Definition: A name associated with the organization
  - setName
```
public Organization setName(String theString)
```
    Sets the value for name ()
    Definition: A name associated with the organization
  - getTelecom
```
public List<ContactPointDt> getTelecom()
```
    Gets the value(s) for telecom (). creating it if it does not exist. Will not return null.
    Definition: A contact detail for the organization
  - setTelecom
```
public Organization setTelecom(List<ContactPointDt> theValue)
```
    Sets the value(s) for telecom ()
    Definition: A contact detail for the organization
  - addTelecom
```
public ContactPointDt addTelecom()
```
    Adds and returns a new value for telecom ()
    Definition: A contact detail for the organization
  - addTelecom
```
public Organization addTelecom(ContactPointDt theValue)
```
    Adds a given new value for telecom ()
    Definition: A contact detail for the organization
    
    Parameters:
    
    theValue - The telecom to add (must not be null)
  - getTelecomFirstRep
```
public ContactPointDt getTelecomFirstRep()
```
    Gets the first repetition for telecom (), creating it if it does not already exist.
    Definition: A contact detail for the organization
  - getAddress
```
public List<AddressDt> getAddress()
```
    Gets the value(s) for address (). 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 ()
    Definition: An address for the organization
  - addAddress
```
public AddressDt addAddress()
```
    Adds and returns a new value for address ()
    Definition: An address for the organization
  - addAddress
```
public Organization addAddress(AddressDt theValue)
```
    Adds a given new value for address ()
    Definition: An address for the organization
    
    Parameters:
    
    theValue - The address to add (must not be null)
  - getAddressFirstRep
```
public AddressDt getAddressFirstRep()
```
    Gets the first repetition for address (), creating it if it does not already exist.
    Definition: An address for the organization
  - getPartOf
```
public ResourceReferenceDt getPartOf()
```
    Gets the value(s) for partOf (). 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 ()
    Definition: The organization of which this organization forms a part
  - getContact
```
public List<Organization.Contact> getContact()
```
    Gets the value(s) for contact (). 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 ()
    Definition:
  - addContact
```
public Organization.Contact addContact()
```
    Adds and returns a new value for contact ()
    Definition:
  - addContact
```
public Organization addContact(Organization.Contact theValue)
```
    Adds a given new value for contact ()
    Definition:
    
    Parameters:
    
    theValue - The contact to add (must not be null)
  - getContactFirstRep
```
public Organization.Contact getContactFirstRep()
```
    Gets the first repetition for contact (), 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 Organization

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_NAME

NAME

SP_PHONETIC

PHONETIC

SP_TYPE

TYPE

SP_IDENTIFIER

IDENTIFIER

SP_PARTOF

PARTOF

SP_ACTIVE

ACTIVE

SP_ADDRESS

ADDRESS

SP_ADDRESS_CITY

ADDRESS_CITY

SP_ADDRESS_STATE

ADDRESS_STATE

SP_ADDRESS_POSTALCODE

ADDRESS_POSTALCODE

SP_ADDRESS_COUNTRY

ADDRESS_COUNTRY

SP_ADDRESS_USE

ADDRESS_USE

INCLUDE_PARTOF

Constructor Detail

Organization

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getActiveElement

getActive

setActive

setActive

getType

setType

setType

getNameElement

getName

setName

setName

getTelecom

setTelecom

addTelecom

addTelecom

getTelecomFirstRep

getAddress

setAddress

addAddress

addAddress

getAddressFirstRep

getPartOf

setPartOf

getContact

setContact

addContact

addContact

getContactFirstRep

getResourceName

getStructureFhirVersionEnum