Class Organization
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.Organization
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement,Serializable,org.hl7.fhir.instance.model.api.IAnyResource,org.hl7.fhir.instance.model.api.IBase,org.hl7.fhir.instance.model.api.IBaseHasExtensions,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions,org.hl7.fhir.instance.model.api.IBaseResource,org.hl7.fhir.instance.model.api.IDomainResource
public class Organization extends DomainResource
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, payer/insurer, etc.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classOrganization.OrganizationContactComponent
-
Field Summary
Fields Modifier and Type Field Description protected BooleanTypeactiveWhether the organization's record is still in active use.static ca.uhn.fhir.rest.gclient.TokenClientParamACTIVEFluent Client search parameter constant for activeprotected List<Address>addressAn address for the organization.static ca.uhn.fhir.rest.gclient.StringClientParamADDRESSFluent Client search parameter constant for addressstatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_CITYFluent Client search parameter constant for address-citystatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_COUNTRYFluent Client search parameter constant for address-countrystatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_POSTALCODEFluent Client search parameter constant for address-postalcodestatic ca.uhn.fhir.rest.gclient.StringClientParamADDRESS_STATEFluent Client search parameter constant for address-statestatic ca.uhn.fhir.rest.gclient.TokenClientParamADDRESS_USEFluent Client search parameter constant for address-useprotected List<StringType>aliasA list of alternate names that the organization is known as, or was known as in the past.protected List<Organization.OrganizationContactComponent>contactContact for the organization for a certain purpose.protected List<Reference>endpointTechnical endpoints providing access to services operated for the organization.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENDPOINTFluent Client search parameter constant for endpointprotected List<Endpoint>endpointTargetThe actual objects that are the target of the reference (Technical endpoints providing access to services operated for the organization.)protected List<Identifier>identifierIdentifier for the organization that is used to identify the organization across multiple disparate systems.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_ENDPOINTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PARTOFConstant for fluent queries to be used to add include statements.protected StringTypenameA name associated with the organization.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected ReferencepartOfThe organization of which this organization forms a part.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARTOFFluent Client search parameter constant for partofprotected OrganizationpartOfTargetThe actual object that is the target of the reference (The organization of which this organization forms a part.)static ca.uhn.fhir.rest.gclient.StringClientParamPHONETICFluent Client search parameter constant for phoneticstatic StringSP_ACTIVESearch parameter: activestatic StringSP_ADDRESSSearch parameter: addressstatic StringSP_ADDRESS_CITYSearch parameter: address-citystatic StringSP_ADDRESS_COUNTRYSearch parameter: address-countrystatic StringSP_ADDRESS_POSTALCODESearch parameter: address-postalcodestatic StringSP_ADDRESS_STATESearch parameter: address-statestatic StringSP_ADDRESS_USESearch parameter: address-usestatic StringSP_ENDPOINTSearch parameter: endpointstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_NAMESearch parameter: namestatic StringSP_PARTOFSearch parameter: partofstatic StringSP_PHONETICSearch parameter: phoneticstatic StringSP_TYPESearch parameter: typeprotected List<ContactPoint>telecomA contact detail for the organization.protected List<CodeableConcept>typeThe kind(s) of organization that this is.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for type-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Organization()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifier for the organization that is used to identify the organization across multiple disparate systems.
-
active
protected BooleanType active
Whether the organization's record is still in active use.
-
type
protected List<CodeableConcept> type
The kind(s) of organization that this is.
-
name
protected StringType name
A name associated with the organization.
-
alias
protected List<StringType> alias
A list of alternate names that the organization is known as, or was known as in the past.
-
telecom
protected List<ContactPoint> telecom
A contact detail for the organization.
-
partOfTarget
protected Organization partOfTarget
The actual object that is the target of the reference (The organization of which this organization forms a part.)
-
contact
protected List<Organization.OrganizationContactComponent> contact
Contact for the organization for a certain purpose.
-
endpoint
protected List<Reference> endpoint
Technical endpoints providing access to services operated for the organization.
-
endpointTarget
protected List<Endpoint> endpointTarget
The actual objects that are the target of the reference (Technical endpoints providing access to services operated for the organization.)
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: 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: partofDescription: An organization of which this organization forms a part
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 partofDescription: An organization of which this organization forms a part
Type: reference
Path: Organization.partOf
-
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".
-
SP_ADDRESS
public static final String SP_ADDRESS
Search parameter: addressDescription: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
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 addressDescription: A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
Type: string
Path: Organization.address
-
SP_ADDRESS_STATE
public static final String SP_ADDRESS_STATE
Search parameter: address-stateDescription: 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-stateDescription: A state specified in an address
Type: string
Path: Organization.address.state
-
SP_ACTIVE
public static final String SP_ACTIVE
Search parameter: activeDescription: Is the Organization record 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 activeDescription: Is the Organization record active
Type: token
Path: Organization.active
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: A code for the type of organization
Type: token
Path: Organization.type
-
SP_ADDRESS_POSTALCODE
public static final String SP_ADDRESS_POSTALCODE
Search parameter: address-postalcodeDescription: 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-postalcodeDescription: 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: address-countryDescription: 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-countryDescription: A country specified in an address
Type: string
Path: Organization.address.country
-
SP_ENDPOINT
public static final String SP_ENDPOINT
Search parameter: endpointDescription: Technical endpoints providing access to services operated for the organization
Type: reference
Path: Organization.endpoint
- See Also:
- Constant Field Values
-
ENDPOINT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENDPOINT
Fluent Client search parameter constant for endpointDescription: Technical endpoints providing access to services operated for the organization
Type: reference
Path: Organization.endpoint
-
INCLUDE_ENDPOINT
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENDPOINT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Organization:endpoint".
-
SP_PHONETIC
public static final String SP_PHONETIC
Search parameter: phoneticDescription: 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 phoneticDescription: A portion of the organization's name using some kind of phonetic matching algorithm
Type: string
Path: Organization.name
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: A portion of the organization's name or alias
Type: string
Path: Organization.name, Organization.alias
- See Also:
- Constant Field Values
-
NAME
public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
Fluent Client search parameter constant for nameDescription: A portion of the organization's name or alias
Type: string
Path: Organization.name, Organization.alias
-
SP_ADDRESS_USE
public static final String SP_ADDRESS_USE
Search parameter: address-useDescription: 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-useDescription: A use code specified in an address
Type: token
Path: Organization.address.use
-
SP_ADDRESS_CITY
public static final String SP_ADDRESS_CITY
Search parameter: address-cityDescription: 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-cityDescription: A city specified in an address
Type: string
Path: Organization.address.city
-
-
Constructor Detail
-
Organization
public Organization()
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier for the organization that is used to identify the organization across multiple disparate systems.)
-
setIdentifier
public Organization setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Organization addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getActiveElement
public BooleanType getActiveElement()
- Returns:
active(Whether the organization's record is still in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
-
hasActiveElement
public boolean hasActiveElement()
-
hasActive
public boolean hasActive()
-
setActiveElement
public Organization setActiveElement(BooleanType value)
- Parameters:
value-active(Whether the organization's record is still in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value
-
getActive
public boolean getActive()
- Returns:
- Whether the organization's record is still in active use.
-
setActive
public Organization setActive(boolean value)
- Parameters:
value- Whether the organization's record is still in active use.
-
getType
public List<CodeableConcept> getType()
- Returns:
type(The kind(s) of organization that this is.)
-
setType
public Organization setType(List<CodeableConcept> theType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasType
public boolean hasType()
-
addType
public CodeableConcept addType()
-
addType
public Organization addType(CodeableConcept t)
-
getTypeFirstRep
public CodeableConcept getTypeFirstRep()
- Returns:
- The first repetition of repeating field
type, creating it if it does not already exist
-
getNameElement
public StringType getNameElement()
- Returns:
name(A name associated with the organization.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
-
hasName
public boolean hasName()
-
setNameElement
public Organization setNameElement(StringType value)
- Parameters:
value-name(A name associated with the organization.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
setName
public Organization setName(String value)
- Parameters:
value- A name associated with the organization.
-
getAlias
public List<StringType> getAlias()
- Returns:
alias(A list of alternate names that the organization is known as, or was known as in the past.)
-
setAlias
public Organization setAlias(List<StringType> theAlias)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAlias
public boolean hasAlias()
-
addAliasElement
public StringType addAliasElement()
- Returns:
alias(A list of alternate names that the organization is known as, or was known as in the past.)
-
addAlias
public Organization addAlias(String value)
- Parameters:
value-alias(A list of alternate names that the organization is known as, or was known as in the past.)
-
hasAlias
public boolean hasAlias(String value)
- Parameters:
value-alias(A list of alternate names that the organization is known as, or was known as in the past.)
-
getTelecom
public List<ContactPoint> getTelecom()
- Returns:
telecom(A contact detail for the organization.)
-
setTelecom
public Organization setTelecom(List<ContactPoint> theTelecom)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTelecom
public boolean hasTelecom()
-
addTelecom
public ContactPoint addTelecom()
-
addTelecom
public Organization addTelecom(ContactPoint t)
-
getTelecomFirstRep
public ContactPoint getTelecomFirstRep()
- Returns:
- The first repetition of repeating field
telecom, creating it if it does not already exist
-
getAddress
public List<Address> getAddress()
- Returns:
address(An address for the organization.)
-
setAddress
public Organization setAddress(List<Address> theAddress)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAddress
public boolean hasAddress()
-
addAddress
public Address addAddress()
-
addAddress
public Organization addAddress(Address t)
-
getAddressFirstRep
public Address getAddressFirstRep()
- Returns:
- The first repetition of repeating field
address, creating it if it does not already exist
-
getPartOf
public Reference getPartOf()
- Returns:
partOf(The organization of which this organization forms a part.)
-
hasPartOf
public boolean hasPartOf()
-
setPartOf
public Organization setPartOf(Reference value)
- Parameters:
value-partOf(The organization of which this organization forms a part.)
-
getPartOfTarget
public Organization getPartOfTarget()
- Returns:
partOfThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The organization of which this organization forms a part.)
-
setPartOfTarget
public Organization setPartOfTarget(Organization value)
- Parameters:
value-partOfThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The organization of which this organization forms a part.)
-
getContact
public List<Organization.OrganizationContactComponent> getContact()
- Returns:
contact(Contact for the organization for a certain purpose.)
-
setContact
public Organization setContact(List<Organization.OrganizationContactComponent> theContact)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
-
addContact
public Organization.OrganizationContactComponent addContact()
-
addContact
public Organization addContact(Organization.OrganizationContactComponent t)
-
getContactFirstRep
public Organization.OrganizationContactComponent getContactFirstRep()
- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist
-
getEndpoint
public List<Reference> getEndpoint()
- Returns:
endpoint(Technical endpoints providing access to services operated for the organization.)
-
setEndpoint
public Organization setEndpoint(List<Reference> theEndpoint)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndpoint
public boolean hasEndpoint()
-
addEndpoint
public Reference addEndpoint()
-
addEndpoint
public Organization addEndpoint(Reference t)
-
getEndpointFirstRep
public Reference getEndpointFirstRep()
- Returns:
- The first repetition of repeating field
endpoint, creating it if it does not already exist
-
getEndpointTarget
@Deprecated public List<Endpoint> getEndpointTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEndpointTarget
@Deprecated public Endpoint addEndpointTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Organization copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Organization dst)
-
typedCopy
protected Organization typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-