Skip to main content
POST
/
api
/
v2
/
hie
/
adt
/
subscribe
Python
from samplehc import SampleHealthcare

client = SampleHealthcare(
    api_key="My API Key",
)
response = client.v2.hie.adt.subscribe(
    address=[{
        "address_line1": "addressLine1",
        "city": "city",
        "state": "state",
        "zip": "zip",
    }],
    dob="dob",
    external_id="externalId",
    first_name="firstName",
    gender_at_birth="M",
    last_name="lastName",
)
print(response)
{}

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

200 - application/json

Default Response

The response is of type object.

⌘I