Create PractitionerRole (Professional Contact)

post

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

Creates a new professional contact identifier linked to their practice

🚧
Prerequisites
Both the professional contact (Practitioner) and their practice (Organization) must be existing records to create the link between them.

Use our recipe

Parameters

Body Params

The new PractitionerRole resource

A PractitionerRole. See https://www.hl7.org/fhir/R4/practitionerrole.html

identifier

array of objects

Business Identifiers that are specific to a role/location

identifier

practitioner

FhirReference.jsonfhir | null

The URL reference to the practitioner's identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)

organization

FhirReference.jsonfhir | null

The URL reference to the clinic location or external practice, wherein the ID includes the appropriate prefix for internal clinic (CL-) or external practice (SP-)

code

array of objects

length ≤ 1

Roles which this practitioner may perform

code

telecom

array of objects

The practitioner's contact number/s or email address/es at the specified location

telecom

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

Prerequisites

Use our recipe

Parameters

201PractitionerRole resource created