Connect (Patient) Reference

After a patient authorizes data, use the access token to call FHIR resources. Below is an example of accessing the patient resource.

get
Get Patient

https://api.1up.health/dstu2/Patient?query-param=queryvalue
This endpoint allows you to access the Patient resource.
Request
Response
Request
Headers
Authorization
required
string
This endpoint receives authentication in the form of a http bearer authentication header.
Query Parameters
query-param
optional
string
Enter the query value string here.
Response
200: OK
Patient successfully retrieved.
{
"resource" : {
"id" : "efcfce77bd6e",
"birthDate" : "1985-08-01",
"gender" : "male",
"identifier" : [
{
"use" : "usual",
"system" : "urn:oid:1.2.840.114350.1.13.0.1.7.5.737384.0",
"value" : "E3967"
},
{
"use" : "usual",
"value" : "203675",
"system" : "urn:oid:1.2.840.114350.1.13.0.1.7.5.737384.14"
},
{
"system" : "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/DSTU2",
"value" : "Tzq4j8Zz14GtEj1vkMR1DfKeTpXPttd5-8DvjtsLBdJsB",
"use" : "usual"
}
],
"active" : true,
"communication" : [
{
"preferred" : true,
"language" : {
"text" : "English",
"coding" : [
{
"system" : "urn:oid:2.16.840.1.113883.6.99",
"code" : "en",
"display" : "English"
}
]
}
}
],
"name" : [
{
"use" : "official",
"text" : "Jason Argonaut",
"family" : [
"Argonaut"
],
"given" : [
"Jason"
]
},
{
"family" : [
"Argonaut"
],
"use" : "usual",
"text" : "Jason Argonaut",
"given" : [
"Jason"
]
}
],
"deceasedBoolean" : false,
"telecom" : [
{
"value" : "608-555-5555",
"system" : "phone",
"use" : "home"
},
{
"use" : "work",
"value" : "469-777-7777",
"system" : "phone"
},
{
"use" : "mobile",
"value" : "123-456-7890",
"system" : "phone"
}
],
"careProvider" : [
{
"display" : "Physician O. Cardiology, MD",
"reference" : "Practitioner/2fc0240080e2"
}
],
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/us-core-race",
"valueCodeableConcept" : {
"coding" : [
{
"display" : "Asian",
"system" : "urn:oid:2.16.840.1.113883.5.104",
"code" : "2028-9"
}
],
"text" : "Asian"
}
},
{
"valueCodeableConcept" : {
"coding" : [
{
"system" : "urn:oid:2.16.840.1.113883.5.50",
"code" : "UNK",
"display" : "Unknown"
}
],
"text" : "Unknown"
},
"url" : "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
},
{
"valueCodeableConcept" : {
"coding" : [
{
"display" : "Male",
"code" : "M",
"system" : "http://hl7.org/fhir/v3/AdministrativeGender"
}
],
"text" : "Male"
},
"url" : "http://hl7.org/fhir/StructureDefinition/us-core-birth-sex"
}
],
"meta" : {
"versionId" : "9000000000000",
"lastUpdated" : "2020-12-02T00:10:31.921Z"
},
"resourceType" : "Patient"
},
"fullUrl" : "https://api.1up.health/dstu2/Patient/efcfce77bd6e",
"search" : {
"mode" : "match"
}
}

get

https://api.1up.health/connect/system/provider/search
Used to run a text search on health systems, often for the purpose of allowing the user to find their health system's authorization portal.
Request
Response
Request
Headers
Authorization
required
string
This endpoint receives authentication in the form of a http bearer authentication header.
Response
200: OK
Providers successfully retrieved.
The result will return a bundle of FHIR® Organizations which
contain the 1upHealth health system id and an extension with
the logo of that org or health system. You can use that to
direct the patient to the correct connect API url so the patient
can authorize sharing of their medical data. See the official
hl7 FHIR® docs (https://www.hl7.org/fhir/bundle.html) for more
information on how a FHIR® bundle is structured.

get
Get Supported Health Systems

https://api.1up.health/connect/system/clinical
Use this endpoint to query the full list of supported health systems. If your use-case would benefit from full-text search of providers on fields like name, address, or clinician names, then we recommend using the Provider Search endpoint instead.
Request
Response
Request
Query Parameters
health_systems_only
optional
string
Enter `true` as the value.
query
optional
string
Enter name of the health system.
Response
200: OK
Returns an array of object containing information about health systems.
[
{
"resource_url" : "string",
"id" : "number",
"name" : "string",
"api_version" : "string",
"status" : "string",
"logo" : "string",
// Location contains addresses and name of health system
"locations" : [],
}
]