Skip to main content

Organization

Normative 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

devhttps://api.sandbox.ovok.com/fhir/R5/Organization
InteractionMethodPath
ReadGET/fhir/R5/Organization/[id]
VreadGET/fhir/R5/Organization/[id]/_history/[vid]
UpdatePUT/fhir/R5/Organization/[id]
PatchPATCH/fhir/R5/Organization/[id]
DeleteDELETE/fhir/R5/Organization/[id]
CreatePOST/fhir/R5/Organization
SearchGET/fhir/R5/Organization?...
HistoryGET/fhir/R5/Organization/[id]/_history
Type-historyGET/fhir/R5/Organization/_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
descriptionmarkdown0..1Additional details about the Organization that could be displayed as further information to identify the Organization beyond its name
contactExtendedContactDetail0..*Official contact details for the Organization
partOfReference0..1The organization of which this organization forms a part
endpointReference0..*Technical endpoints providing access to services operated for the organization
qualificationBackboneElement0..*Qualifications, certifications, accreditations, licenses, training, etc. pertaining to the provision of care

Resource-specific search parameters

ParameterTypeDescription
activetokenIs the Organization record active
addressstringA server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
address-citystringA city specified in an address
address-countrystringA country specified in an address
address-postalcodestringA postal code specified in an address
address-statestringA state specified in an address
address-usetokenA use code specified in an address
endpointreferenceTechnical endpoints providing access to services operated for the organization
identifiertokenAny identifier for the organization (not the accreditation issuer's identifier)
namestringA portion of the organization's name or alias
partofreferenceAn organization of which this organization forms a part
phoneticstringA portion of the organization's name using some kind of phonetic matching algorithm
typetokenA code for the type of organization

Reference

  • Official FHIR R5 spec: Organization
  • Maturity: Normative (FMM 5).