Create Referral

post

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

Creates a new Referral record

Body Params

A Referral.

coverage

FhirReference.jsonfhir | null

The URL reference to the coverage (i.e. claim details) where this referral is or will be filed under

period

FhirPeriodDate.jsonfhir | null

Period when the referral is valid

performer

FhirReference.jsonfhir | null

The URL reference to the practitioner that this referral is assigned to, wherein the ID includes the prefix PR-

requester

FhirReference.jsonfhir | null

The URL reference to the referring external practitioner/clinic (PractitionerRole), wherein the ID includes the prefix EP-

referralDefinition

FhirReference.jsonfhir | null

The name of the referral type used

created

date-time | null

Date when the referral was created

active

boolean | null

Indicates if this referral is an active and valid referral

limitQuantity

LimitQuantity.jsonfhir | null

Limit on the quantity of services

limitMoney

LimitMoney.jsonfhir | null

Limit on the monetary value of services

subject

FhirReference.jsonfhir | null

The URL reference to the patient whom this referral is for

includeCancelledAppointment

boolean | null

Indicates whether the referral is also applied to cancelled appointments

comment

string | null

Notes added to the referral

attachments

array of objects

File attachments to the referral

attachments

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

201Referral resource created