API Reference

Create Practitioner (Professional Contact)

post
https://au-api.halaxy.com/main/Practitioner

Creates a new professional contact profile (i.e. external practitioner)

Body Params

The new Practitioner resource

identifier
array of objects

Identifies this practitioner across multiple systems

identifier
boolean | null

Indicates if the user's record is in active use - changes to false if the user's profile is deactivated from the practice group

name
array of objects

The name/s associated with the practitioner

name
telecom
array of objects

A unique email address linked to the practitioner

telecom
address
array of objects

Address(es) of the practitioner that are not role specific

address
string | null
enum

male | female | other | unknown

Allowed:
string | null

The date on which the practitioner was born

qualification
array of objects
length ≤ 1

The practitioner's profession in their profile

qualification
meta

Metadata about the resource

string | null

Resource Type

Headers
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
Responses

400

Invalid input

403

Forbidden

422

Unprocessable entity

Updated 10 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json
application/json

Updated 10 months ago