This resource provides a flexible framework for managing organizational details, relationships and billing across Halaxy.

Each organization data type is distinguished by a prefix.

Prefix	Data Type
PG-	Practice Group
CL-	Clinic
OG-	Organization
FD-	Funder
SP-	Professional Contact's Practice

Note: The prefixes are only for referencing resources in the API and do not appear in Halaxy.

Endpoints

Endpoint	Operation	Description
`GET` `/main/Organization`	List Organizations	Return a list or collection of organizations in a practice group
`GET` `/main/Organization/{id}`	Get Organization	Return an individual organization in a practice group
`POST` `/main/Organization`	Create Organization (Professional Contact Practice)	Create a new organization record for a professional contact's practice location

Schema

Property	Description
id	`string` The identifier of this organization The two-letter prefix indicates whether it is a practice group, clinic, funder, external organization or a professional contact's practice. e.g. `"PG-1234567"` `"CL-1234567"` `"OG-1234567"` `"FD-1234567"` `"SP-1234567"`
active	`boolean` Whether the organization is in active use
type	`array of objects` The kind of organization `"system": "http://terminology.hl7.org/CodeSystem/organization-type"` code: See Organization Type list display: See Organization Type list
name	`string` The name of the practice group, clinic/location, organization, funder or professional contact practice
telecom	`array of objects` A contact number or email system Type of contact detail `sms` \| `phone` \| `fax` \| `email` value The actual phone number or email address e.g. `+61412345678` `leeblake@email.com` use Purpose of the contact detail `home` \| `work` \| `mobile` Note: Phone format must be`+{country code}{phone number without spaces}`
address	`array of objects` The organization's address use `string` The purpose of this address `home` `work` `billing` `mailing` type `string` Distinguishes between a physical address and mailing address `postal` `physical` `both` text `string` Specifies the full address as it should be displayed (e.g. on a postal label) line `array of strings` Contains the house number, apartment number, P.O. box number, street name. city `string` state `string` postalCode `string` country `string` min 2 characters The ISO 3166 two-letter code - e.g. `AU` `CA`
partOf	`Reference(Organization)` for clinic locations only The practice group that the clinic belongs to `"reference": "/main/Organization/PG-123456"` `"type": "Organization"`