HAhalaxy
Organization

List Organizations

Changed on

Retrieves a collection of organizations in a practice group

get/main/Organization

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/Organization
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_summary[]string[]
_idstring

The logical id of the resource

namestring

Organization name

_lastUpdatedstring datetime

Organization _lastUpdated

_profile'StructureDefinition/hx-organization-practice-group' | 'StructureDefinition/hx-organization-clinic' | 'StructureDefinition/hx-organization-funder' | 'StructureDefinition/hx-organization-organisation' | 'StructureDefinition/hx-organization-external-clinic' | 'StructureDefinition/hx-organization-external-clinic'

The _profile parameter can be used to select different types of a resources.

Response

Organization collection

activeboolean nullable

Whether the organization is in active use

namestring nullable

The name of the practice group, clinic/location, organization, funder or professional contact practice

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the /////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the //////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ////// response property for the response status (media type: application/json)