Organization

ResourceBase · EntitiesTrial useMaturity 3

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

13 of 13 parameters tested

Structure

Show inherited elements (11)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Identifies this organization across multiple systems
active?!Σ	0..1	boolean	Whether the organization's record is still in active use
typeΣ	0..*	CodeableConcept	Kind of organizationBinding (example): organization-type
nameΣ	0..1	string	Name used for the organization
alias	0..*	string	A list of alternate names that the organization is known as, or was known as in the past
telecom	0..*	ContactPoint	A contact detail for the organization
address	0..*	Address	An address for the organization
partOfΣ	0..1	Reference(Organization)	The organization of which this organization forms a part
contact	0..*	BackboneElement	Contact for the organization for a certain purpose
purpose	0..1	CodeableConcept	The type of contactBinding (extensible): contactentity-type
name	0..1	HumanName	A name associated with the contact
telecom	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
address	0..1	Address	Visiting or postal addresses for the contact
endpoint	0..*	Reference(Endpoint)	Technical endpoints providing access to services operated for the organization

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Organization?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
active	token	Is the Organization record active Organization.active
address	string	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 Organization.address
address-city	string	A city specified in an address Organization.address.city
address-country	string	A country specified in an address Organization.address.country
address-postalcode	string	A postal code specified in an address Organization.address.postalCode
address-state	string	A state specified in an address Organization.address.state
address-use	token	A use code specified in an address Organization.address.use
endpoint	reference	Technical endpoints providing access to services operated for the organization Organization.endpoint
identifier	token	Any identifier for the organization (not the accreditation issuer's identifier) Organization.identifier
name	string	A portion of the organization's name or alias Organization.name | Organization.alias
partof	reference	An organization of which this organization forms a part Organization.partOf
phonetic	string	A portion of the organization's name using some kind of phonetic matching algorithm Organization.name
type	token	A code for the type of organization Organization.type

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition