Patient

The Patient resource provides the "demographics and other administrative information about an individual or animal receiving care or other health-related services." (HL7 FHIR R4 Patient)

Supported Profiles

This API supports the following FHIR profiles:

• HL7 FHIR R4 Patient
• US Core Patient

Operations

The Certified API Patient resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / Solution	Create	Read	Update	Search
GEHRIMED	-	Yes	-	Yes
myAvatar	-	Yes	-	Yes
myEvolv	-	Yes	-	Yes
myUnity	-	Yes	-	Yes
TheraOffice	-	Yes	-	Yes

Search

info

Not all Netsmart solutions support Patient search. See supported operations table above and consult your target solution's documentation for more information.

This operation retrieves a list of resources by these query parameters.

Standard Parameters

Name	Type	Description
birthdate	date	The patient's date of birth
death-date	date	The date of death has been provided and satisfies this search value
family	string	A portion the family name of the patient
gender	token	Gender of the patient
given	string	A portion of the given name of the patient
identifier	token	An identifier for this patient
name	string	A name associated with the patient
page	string	Zero-based page index
_id	id	Unique identifier of the Patient.
_revinclude	special	Include Provenance resource(s) that reference the matched search results. Allowed: "Provenance:target"

Search Examples

Via POST

The POST method is recommended as it keeps health information out of the URL.

Production

Search by Date of Birth

curl -X POST https://fhir.netsmartcloud.com/uscore/v1/Patient/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \ 
    -d "birthdate=ge1996-03-28" \
    -d "birthdate=le1996-03-30"

Search by US Social Security Number

curl -X POST https://fhir.netsmartcloud.com/uscore/v1/Patient/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \ 
    -d "identifier=http://hl7.org/fhir/sid/us-ssn|123456789"

Preview

Search by Date of Birth

curl -X POST https://fhirtest.netsmartcloud.com/uscord/v1/Patient/_search \ 
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "birthdate=ge1996-03-28" \
    -d "birthdate=le1996-03-30"

Search by US Social Security Number

curl -X POST https://fhirtest.netsmartcloud.com/uscord/v1/Patient/_search \ 
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "identifier=http://hl7.org/fhir/sid/us-ssn|123456789"

Via GET

Production

Search by Birth Date

curl -X GET "https://fhir.netsmartcloud.com/uscore/v1/Patient?birthdate=ge1996-03-28&birthdate=le1996-03-30" \ 
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Search by US Social Security Number

curl -X GET "https://fhir.netsmartcloud.com/uscord/v1/Patient?identifier=http://hl7.org/fhir/sid/us-ssn|123456789" \ 
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Preview

Search by Birth Date

curl -X GET "https://fhirtest.netsmartcloud.com/uscore/v1/Patient?birthdate=ge1996-03-28&birthdate=le1996-03-30" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Search by US Social Security Number

curl -X GET "https://fhirtest.netsmartcloud.com/uscord/v1/Patient?identifier=http://hl7.org/fhir/sid/us-ssn|123456789" \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"