API Reference

Create Patient

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

Creates a patient record

Use our recipe


Parameters

Body Params

The new Patient resource

Demographics and other administrative information about an individual or animal receiving care or other health-related services. See https://www.hl7.org/fhir/R4/patient.html

name
array of objects
required

The name of the patient

name*
telecom
array of objects

A contact detail for the individual

telecom
string | null

male | female | other | custom gender

date | null

The date of birth for the individual

boolean | null

Indicates whether this patient profile is deceased based on the patient status

address
array of objects

An address for the individual

address
contact
array of objects

A contact party (e.g. guardian, partner, friend) for the patient

contact
attachments
array of objects

File attachments to the patient profile. Write-only: accepted in the request body (e.g. POST/PUT) but not returned in any response, including GET /Patient.

attachments
FhirResourceMeta.jsonfhir | null

Metadata about the resource

string | null

Resource Type

Headers
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
string
enum
Defaults to application/fhir+json

Generated from available request content types

Allowed:
Responses

400

Invalid input

403

Forbidden

422

Unprocessable entity

Updated 3 months ago

Did this page help you?
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 3 months ago

Did this page help you?