Skip to main content
POST
/
api
/
v2
/
hie
/
documents
/
query
Query patient documents
curl --request POST \
  --url https://api.example.com/api/v2/hie/documents/query \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "dob": "<string>",
  "genderAtBirth": "M",
  "address": [
    {
      "addressLine1": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zip": "<string>",
      "addressLine2": "<string>",
      "country": "USA"
    }
  ],
  "externalId": "<string>",
  "personalIdentifiers": [],
  "contact": []
}
'
{
  "asyncResultId": "<string>"
}

Body

application/json
​
firstName
string
required

The Patient's first name(s).

​
lastName
string
required

The Patient's last name(s).

​
dob
string
required

The Patient's date of birth (DOB), formatted YYYY-MM-DD as per ISO 8601.

​
genderAtBirth
enum<string>
required

The Patient's gender at birth, can be one of M or F or O or U. Use O (other) when the patient's gender is known but it is not M or F, i.e intersex or hermaphroditic. Use U (unknown) when the patient's gender is not known.

Available options:
M,
F,
O,
U
​
address
object[]
required

An array of Address objects, representing the Patient's current and/or previous addresses. May be empty.

​
externalId
string
required

An external Patient ID that you store and can use to reference this Patient.

​
personalIdentifiers
object[]

An array of the Patient's personal IDs, such as a driver's license or SSN. May be empty.

​
contact
object[]

An array of Contact objects, representing the Patient's current and/or previous contact information. May be empty.

Response

202 - application/json

Default Response

​
asyncResultId
string
required

The async result ID. When the async result completes, the result will contain both FHIR bundle and document objects.