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.

Find Patients

GET

/v1/{practiceid}/fhir/dstu2/Patient

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

Input Parameters

required

practiceid	integer	practiceid
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

address	array	Addresses for the individual
city	string	Name of city, town etc.
country	string	Country (can be ISO 3166 3 letter code)
district	string	District name (aka county)
line	string	Street name, number, direction & P.O. Box etc.
period	string	Time period when address was/is in use
postalcode	string	Postal code for area
state	string	Sub-unit of country (abbreviations ok)
text	string	Text representation of the address
type	string	postal | physical | both
use	string	home | work | temp | old – purpose of this address
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
language	object	The language which can be used to communicate with the patient about his or her health
coding	object	Language Coding
coding	array	Code defined by a terminology system
code	string	Symbol in syntax defined by the system
display	string	Representation defined by the system
system	string	Identity of the terminology system
text	string	Plain text representation of the concept
text	string	Language Text
preferred	string	Language preference indicator
extension	array	Additional Content defined by implementations
url	string	Identifies the meaning of the extension
valuecodeableconcept	object	Value of extension
coding	array	Code defined by a terminology system
code	string	Symbol in syntax defined by the system
display	string	Representation defined by the system
system	string	Identity of the terminology system
text	string	Plain text representation of the concept
gender	string	male | female | other | unknown
id	string	Logical id of this artifact
identifier	object	An identifier for this patient
system	string	Identifier System
use	string	Identifier Use
value	string	Identifier Value
name	object	A name associated with the patient
family	string	List of family names for this patient
given	string	List of given names for this patient
use	string	Purpose of this name
resourcetype	string	The type of resource
telecom	object	A contact detail for the individual
system	string	Telecom system
use	string	Use of this telecom – home | work
value	string	Telecom value

Get a single patient

GET

/v1/{practiceid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. Date filtering does not apply.

Input Parameters

required

practiceid	integer	practiceid
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

address	array	Addresses for the individual
city	string	Name of city, town etc.
country	string	Country (can be ISO 3166 3 letter code)
district	string	District name (aka county)
line	string	Street name, number, direction & P.O. Box etc.
period	string	Time period when address was/is in use
postalcode	string	Postal code for area
state	string	Sub-unit of country (abbreviations ok)
text	string	Text representation of the address
type	string	postal | physical | both
use	string	home | work | temp | old – purpose of this address
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
language	object	The language which can be used to communicate with the patient about his or her health
coding	object	Language Coding
coding	array	Code defined by a terminology system
code	string	Symbol in syntax defined by the system
display	string	Representation defined by the system
system	string	Identity of the terminology system
text	string	Plain text representation of the concept
text	string	Language Text
preferred	string	Language preference indicator
extension	array	Additional Content defined by implementations
url	string	Identifies the meaning of the extension
valuecodeableconcept	object	Value of extension
coding	array	Code defined by a terminology system
code	string	Symbol in syntax defined by the system
display	string	Representation defined by the system
system	string	Identity of the terminology system
text	string	Plain text representation of the concept
gender	string	male | female | other | unknown
id	string	Logical id of this artifact
identifier	object	An identifier for this patient
system	string	Identifier System
use	string	Identifier Use
value	string	Identifier Value
name	object	A name associated with the patient
family	string	List of family names for this patient
given	string	List of given names for this patient
use	string	Purpose of this name
resourcetype	string	The type of resource
telecom	object	A contact detail for the individual
system	string	Telecom system
use	string	Use of this telecom – home | work
value	string	Telecom value