Log in Request access

Organization

A clinic, practice group, or other healthcare organization.

Organizations appear as the managing entity behind locations, roles, and encounters. In the sandbox there is a single synthetic clinic organization.

Advertises a validated CA Core+ profile.

Access

Mode Interactions Scopes
App launch read + search user/Organization.rs
Backend services read + search system/Organization.rs

Search parameters

Search results are searchset Bundles; follow the Bundle's next link for cursor pagination.

Parameter Type Description
_id token Match a specific logical resource id.
_lastUpdated date Filter by last modification time; supports FHIR date prefixes such as ge and lt.
_count number Page size hint for the searchset Bundle.
_page_token string Opaque pagination cursor. Never construct one — follow the Bundle's next link.
identifier token Business identifier for the organization.
name string Organization name.
active token Whether the record is in active use (true/false).

Read an organization

GET /Organization/{id} 200 OK
Request
curl "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Organization/synthetic-organization-1" \
  -H "Authorization: Bearer $SMART_ACCESS_TOKEN" \
  -H "Accept: application/fhir+json"
Response · launch context
{
  "resourceType": "Organization",
  "id": "synthetic-organization-1",
  "meta": {
    "profile": ["http://fhir.infoway-inforoute.ca/io/CA-Core/StructureDefinition/organization-ca-core|1.1.0"]
  },
  "active": true,
  "name": "Maplewood Family Health Team",
  "telecom": [{ "system": "phone", "value": "555-0199" }]
}