FHIR DSTU2 - Patient

These FHIR Patient endpoints are a partial implementation of the FHIR DSTU2 specification. We will consider expanding these and adding additional FHIR endpoints, as well as future versions, based on usage and requests from API users.

Note-1: that these endpoints do not follow the same naming conventions as many of the other APIs offered.

Note-2: If you are accessing a practice without Communicator Brands and are using one of the endpoints that require BRANDID in the path, you can use any positive integer for BRANDID.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Find Patients
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Patient

List of Patient resources from the results of the search. Date filtering does not apply.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
given string The given name associated with the patient.
identifier string The system-code identifier of the patient.
_id integer The patient ID. Per the FHIR spec, this is "_id", not "patientid" as with other API calls.
birthdate string The birthdate of the patient.
name string The name associated with the patient.
family string The family name associated with the patient.
gender string The gender of the patient.
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
address array Addresses for the individual
birthdate string The date of birth for the individual
communication array A list of Languages which may be used to communicate with the patient about his or her health
extension array Additional Content defined by implementations
gender string male | female | other | unknown
id string Logical id of this artifact
identifier object An identifier for this patient
name object A name associated with the patient
resourcetype string The type of resource
telecom object A contact detail for the individual
Example Code
Get a single patient
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. Date filtering does not apply.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
patientid integer patientid
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
address array Addresses for the individual
birthdate string The date of birth for the individual
communication array A list of Languages which may be used to communicate with the patient about his or her health
extension array Additional Content defined by implementations
gender string male | female | other | unknown
id string Logical id of this artifact
identifier object An identifier for this patient
name object A name associated with the patient
resourcetype string The type of resource
telecom object A contact detail for the individual
Example Code
Find patients by brand and chart
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient

List of Patient resources from the results of the search. Date filtering does not apply.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
_id integer The patient ID. Per the FHIR spec, this is "_id", not "patientid" as with other API calls.
THIRDPARTYUSERNAME string User name of the patient in the third party application.
PATIENTFACINGCALL boolean When 'true' is passed we will collect relevant data and store in our database.

Output Parameters

Expand all
address array Addresses for the individual
birthdate string The date of birth for the individual
communication array A list of Languages which may be used to communicate with the patient about his or her health
extension array Additional Content defined by implementations
gender string male | female | other | unknown
id string Logical id of this artifact
identifier object An identifier for this patient
name object A name associated with the patient
resourcetype string The type of resource
telecom object A contact detail for the individual
Example Code
Get a single patient
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. Date filtering does not apply.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
patientid integer patientid
chartsharinggroupid integer chartsharinggroupid

Output Parameters

Expand all
address array Addresses for the individual
birthdate string The date of birth for the individual
communication array A list of Languages which may be used to communicate with the patient about his or her health
extension array Additional Content defined by implementations
gender string male | female | other | unknown
id string Logical id of this artifact
identifier object An identifier for this patient
name object A name associated with the patient
resourcetype string The type of resource
telecom object A contact detail for the individual
Example Code
Get a SMART health card for a patient
POST
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}/$health-cards-issue

BETA: Parameters resource that includes one or more verifiable credentials

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
patientid integer patientid
chartsharinggroupid integer chartsharinggroupid
Content-Type string Content type of the payload

Output Parameters

Expand all
parameter array
resourcetype string The type of resource (Parameters)
Example Code