API Reference

Retrieve All Appointments for a Practice/Firm

get
https://stage.ema-api.com/ema-dev/firm/apiportal/ema/fhir/v2/Appointment
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use Authentication Endpoint page to get token

Query Params
string

Number of records to use as the page size for paginated search. The maximum page size for this Resource is 50

date

This is an Optional Date in the format lastUpdated=gtDATE, lastUpdated=eqDATE and _lastUpdated=leDATE in the format yyyy-mm-dd

string

The style of appointment or patient that has been booked in the slot (not service type)

date

Created date in format of yyyy-MM-dd'T'HH:mm:ss.SSSSSSSZ

date

Appointment date/time.

string

This location is listed in the participants of the appointment

string

Page to be used for paginated search

string

One of the individuals of the appointment is this patient

string

One of the individuals of the appointment is this practitioner

string

The overall status of the appointment

string

Additional information to support the appointment

Headers
string
enum

Optional header. Referral adds Referral Contact and Referral Source information to the Appointment payload.

Allowed:
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
Responses

400

BAD REQUEST - The request was bad, often due to a missing required parameter

401

NOT AUTHORIZED - Authentication error; this token is not allowed access to the API

403

FORBIDDEN

404

NOT FOUND

422

UNPROCESSABLE ENTITY - Request could not be processed; typically a validation error

429

TOO MANY REQUESTS - Request was rate limited (1000 calls/min default); please retry

500

SERVER ERROR - Internal Server Error

Updated 23 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json

Updated 23 days ago

Did this page help you?