Create Organization (Professional Contact Practice)

post

https://au-api.halaxy.com/main/Organization

Creates a new organization record for a professional contact's practice location

The professional contact profile must be linked to their practice location in order to add them to referrals.

Use our recipe

Parameters

Body Params

The new Organization resource

An Organization within halaxy represents a Clinic. See https://hl7.org/fhir/r4/organization.html

identifier

array of objects

Identifies this organization across multiple systems

identifier

active

boolean | null

Whether the organization is in active use

type

array of objects

The kind of organization

type

name

string | null

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

telecom

array of objects

A contact number or email for the organization

telecom

address

array of objects

The organization's address

address

partOf

FhirReference.jsonfhir | null

The practice group that the clinic belongs to (for clinic locations only)

meta

FhirResourceMeta.jsonfhir | null

Metadata about the resource

resourceType

string | null

Resource Type

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/fhir+json

Generated from available request content types

Allowed:

Responses

400

Invalid input

403

Forbidden

422

Unprocessable entity

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

application/json

Use our recipe

Parameters

201Organization resource created