Class Organization

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:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class Organization extends BaseResource implements ca.uhn.fhir.model.api.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
  • Field Details

    • 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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.rest.gclient.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 ca.uhn.fhir.model.api.Include INCLUDE_PARTOF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Organization:partof".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • 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

      Sets the value(s) for identifier (id)

      Definition: Identifier for the organization that is used to identify the organization across multiple disparate systems

    • 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

      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 ca.uhn.fhir.model.primitive.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. This method may return null.

      Definition: Whether the organization's record is still in active use

    • setActive

      public Organization setActive(ca.uhn.fhir.model.primitive.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

      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(CodeableConceptDt theValue)
      Sets the value(s) for type (class)

      Definition: The kind of organization that this is

    • getNameElement

      public ca.uhn.fhir.model.primitive.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. This method may return null.

      Definition: A name associated with the organization

    • setName

      public Organization setName(ca.uhn.fhir.model.primitive.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

      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

      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

      Gets the first repetition for telecom (), creating it if it does not already exist.

      Definition: A contact detail for the organization

    • 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

      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

      Gets the first repetition for address (), creating it if it does not already exist.

      Definition: An address for the organization

    • 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

      Sets the value(s) for partOf ()

      Definition: The organization of which this organization forms a part

    • getContact

      Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

      Definition:

    • setContact

      Sets the value(s) for contact ()

      Definition:

    • addContact

      Adds and returns a new value for contact ()

      Definition:

    • addContact

      Adds a given new value for contact ()

      Definition:

      Parameters:
      theValue - The contact to add (must not be null)
    • getContactFirstRep

      Gets the first repetition for contact (), creating it if it does not already exist.

      Definition:

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource