Skip to main content

Organization

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.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

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​

ElementTypeCardinalityDescription
idstring0..1Logical id of this artifact
metaMeta0..1Metadata about the resource
implicitRulesuri0..1A set of rules under which this content was created
languagecode0..1Language of the resource content
textNarrative0..1Text summary of the resource, for human interpretation
containedResource0..*Contained, inline Resources
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored
identifierIdentifier0..*Identifies this organization across multiple systems
activeboolean0..1Whether the organization's record is still in active use
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
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 R4 spec: Organization.
Maturity: Trial Use 3 (FMM 3).