Drs® Enterprise - FHIR®© API Documentation

Searching For A Patient

On this page:

Search For A Patient | Patient Demographics and Care Team

GET https://<hosturl>/FHIR/<databasename>/Patient?given=Smith
GET https://<hosturl>/FHIR/<databasename>/Patient?given=Smith&gender=male
GET https://<hosturl>/FHIR/<databasename>/Patient?given=Smith&gender=male&birthdate=1973-03-05

The following parameters are specified in the search query:

Name Required? Type Description
family Yes string Portion of the family (last) name of the patient.
given No string Portion of the given (first) name of the patient.
gender No string Patient’s gender. For more information on this value set, see Administrative Gender ValueSet.
birthdate No date Patient’s date of birth.

The response would be similar to the following:

JSON:

{
    "resourceType": "Bundle",
    "id": "EBC3FEEA-D2F1-4D23-9886-9C5D6DF21994",
    "type": "searchset",
    "total": 1,
    "entry":
    [
        {
        "id": 290,
        "family": "Smith",
        "given": "Anthony",
        "gender": "M",
        "birthdate": "1965-10-21"
        }
    ]
}

XML:

<Bundle xml="http://hl7.org/fhir">
  <id value="616EBF2D-3E3B-40FF-B318-3706629C42B0" />
  <type value="searchset" />
  <total value="1" />
  <entry>
    <resource>
      <id>290</id>
      <family>Smith</family>
      <given>Anthony</given>
      <gender>M</gender>
      <birthdate>1965-10-21</birthdate>
    </resource>
  </entry>
 </Bundle>

 

Patient Demographics and Care Team

The patient demographics and care team are returned in one bundle.

GET https://<hosturl>/FHIR/<databasename>/Patient/123/PatientDemographics

 

Name Required? Type Description
id Yes string The logical ID of the patient. This is retrieved using the search function.

This API call returns all patient data for patient demographics and care team.

Sample Output