Organization Resource

The FHIR Organization resource represents an organisation or site within AdvaPACS. Organization resources can be referenced by other FHIR resources where an organisation, provider group, site, or owning entity needs to be identified.

For full information on the ImagingStudy resource, please refer to the FHIR standard.

Note

Organization resources are available when the Organisations & Sites feature is enabled for the AdvaPACS tenant.

Supported Transactions

AdvaPACS supports the following transactions for the Organization resource:

Function	Method	Endpoint	Description
Get Organization	GET	/Organization/{id}	Retrieves a specific Organization resource by its logical ID.
Search Organizations	GET	/Organization	Searches for Organization resources using one or more supported search parameters.

Examples

The following examples show how to retrieve and search for Organization resources using the AdvaPACS FHIR API. These examples demonstrate how configured AdvaPACS Organisations are represented in FHIR and how Organization resources can be located using supported search parameters.

Get an Organization

A specific Organization can be retrieved using the logical ID assigned to the resource. The response contains information about the corresponding AdvaPACS Organisation, including its name, identifier, active status, and configured address details.

GET /fhir/R5/Organization/[Organization_ID]
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

For example, to retrieve an Organization with logical ID b0eef8ff-6f17-4222-a85e-5f5fd3259618:

GET /fhir/R5/Organization/b0eef8ff-6f17-4222-a85e-5f5fd3259618
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful request returns the requested Organization resource:

{
  "resourceType": "Organization",
  "id": "b0eef8ff-6f17-4222-a85e-5f5fd3259618",
  "identifier": [
    {
      "value": "EXAMPLE"
    }
  ],
  "active": true,
  "name": "Example Radiology",
  "address": [
    {
      "text": "1 Infinite Loop, Big Street, The World"
    }
  ],
  "contact": [
    {
      "address": {
        "text": "1 Infinite Loop, Big Street, The World"
      }
    }
  ]
}

Search Organizations

Organization resources can be searched using one or more supported FHIR search parameters. Multiple parameters may be included in the same request to further refine the results returned by the FHIR API. The following search parameters are supported by the AdvaPACS Organization resource:

Parameter	Description	Example
_id	Search by the logical FHIR resource ID.	?_id=b0eef8ff-6f17-4222-a85e-5f5fd3259618
active	Filter Organizations by active status (true or false).	?active=true
identifier	Search using an organisation identifier.	?identifier=EXAMPLE
name	Search by organisation name. Supports partial matching.	?name=Central

For example, to search for Organizations whose name matches Central:

GET /fhir/R5/Organization?name=Central
Authorization: ID=<ApiId>,Secret=<ApiSecret>
Accept: application/fhir+json
Host: <FhirEndpoint>

A successful search returns a FHIR Bundle with a type of searchset. Each matching Organization is included as an entry within the bundle, and the total property indicates the number of matching resources.

{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 1,
  "entry": [
    {
      "resource": {
        "resourceType": "Organization",
        "id": "b0eef8ff-6f17-4222-a85e-5f5fd3259618",
        "name": "Example Radiology",
        "active": true
      }
    }
  ]
}

If no matching Organizations are found, an empty searchset Bundle is returned with a total of 0.