Skip to main content

Organization

Trial Use 3 Base

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.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/Organization
InteractionMethodPath
ReadGET/fhir/R4/Organization/[id]
VreadGET/fhir/R4/Organization/[id]/_history/[vid]
UpdatePUT/fhir/R4/Organization/[id]
PatchPATCH/fhir/R4/Organization/[id]
DeleteDELETE/fhir/R4/Organization/[id]
CreatePOST/fhir/R4/Organization
SearchGET/fhir/R4/Organization
HistoryGET/fhir/R4/Organization/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Identifies this organization across multiple systems
activeboolean0..1Whether the organization's record is still in active use modifier
typeCodeableConcept0..*Kind of organization
namestring0..1Name used for the organization
aliasstring0..*A list of alternate names that the organization is known as, or was known as in the past
telecomContactPoint0..*A contact detail for the organization
addressAddress0..*An address for the organization
partOfReference0..1The organization of which this organization forms a part
contactBackboneElement0..*Contact for the organization for a certain purpose
endpointReference0..*Technical endpoints providing access to services operated for the organization

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
activestringhttp://hl7.org/fhir/SearchParameter/Organization-active
addressstringhttp://hl7.org/fhir/SearchParameter/Organization-address
address-citystringhttp://hl7.org/fhir/SearchParameter/Organization-address-city
address-countrystringhttp://hl7.org/fhir/SearchParameter/Organization-address-country
address-postalcodestringhttp://hl7.org/fhir/SearchParameter/Organization-address-postalcode
address-statestringhttp://hl7.org/fhir/SearchParameter/Organization-address-state
address-usestringhttp://hl7.org/fhir/SearchParameter/Organization-address-use
endpointstringhttp://hl7.org/fhir/SearchParameter/Organization-endpoint
identifierstringhttp://hl7.org/fhir/SearchParameter/Organization-identifier
namestringhttp://hl7.org/fhir/SearchParameter/Organization-name
partofstringhttp://hl7.org/fhir/SearchParameter/Organization-partof
phoneticstringhttp://hl7.org/fhir/SearchParameter/Organization-phonetic
typestringhttp://hl7.org/fhir/SearchParameter/Organization-type

Reference​

  • Official FHIR R4 spec: Organization
  • Maturity: Trial Use 3 (FMM 3).