@1uphealth-temp/api 中文文档教程

Question

@1uphealth/api

ApiSDK

APIURLBASE

类型：string

getUsers

GET /user-management/v1/user

获取存在于您的 1up 开发者应用程序中的所有用户的列表， 具有按特定用户过滤的选项

Parameters

• oneUpUserId OneUpUserId?
• appUserId AppUserId?

Returns Promise< /strong> 用户对象数组

createUser

POST /user-management/v1/user

将导致使用请求正文中传递的属性创建用户。 \ 如果用户已经存在，请求不会失败，而是会返回用户数据，但

Parameters

• appUserId AppUserId
• userActive UserActive

返回 Promise

updateUser

PUT /user-management/v1/user

可用于修改现有用户对象。 可以修改appuserid， 但是 oneupuserid 是在创建用户时分配的，不能更改。

Parameters

• appUserId AppUserId
• oneUpUserId OneUpUserId
• userActive UserActive

返回 Promise将返回新用户object

generateUserAuthCode

POST /user-management/v1/user/auth-code

后端应用程序可以使用此端点为用户获取新的授权代码。 \ 请注意，不应在浏览器上下文中调用此端点，因为 \ 它需要向用户公开您应用程序的密钥。

Parameters

• appUserId AppUserId

返回 Promise返回一个访问令牌和刷新令牌， 可用于验证代表用户发出的请求。

getHealthSystemPickerIFrame

GET /connect/marketplace

一种常见的模式是要求用户将数据从他们的健康系统连接到应用程序。 \ 此端点返回一个简单的 html 页面，可用作行走的起点 \ 用户通过数据连接流。 更多细节， \ 了解 https://1up.health/dev/doc/connect-health-data-iframe。

返回 Promise此端点返回一个 html页面和内联 css，在呈现时会生成 \ 选择用户想要连接的医疗保健系统。 最常用的\ 这是为了在开发人员自己的应用程序内的 iframe 中呈现此端点。

searchConnectProvider

GET /connect/system/provider

用于在健康系统上运行文本搜索，通常是为了允许用户 \ 找到他们健康系统的授权门户。

Parameters

• query Query { query: string; } \ This is how you specify the text to search for. \ It can be a doctor's name, clinic, hospital, or address.

返回 Promise结果会返回一个包含 1upHealth \ 卫生系统 ID 和带有该组织或卫生系统徽标的扩展名。 \ 您可以使用它来将患者引导至正确的连接 api url，以便患者\ 可以授权共享他们的医疗数据。 \ 请参阅官方 hl7 FHIR 文档 (https://www.hl7.org/fhir/bundle.html)\ 有关 FHIR 包的结构的更多信息。

getDevices

GET /connect/system/device

目前，1upHealth 允许从 Fitbit、GoogleFit 或 Withings 导入数据。

返回 Promise返回设备列表可以用作源的类型。

getSupportedHealthSystems

GET /connect/system/clinical

使用此端点查询支持的健康系统的完整列表。 \ 如果您的用例将受益于对字段提供者的全文搜索 \ 如姓名、地址或临床医生姓名，那么我们建议 \ 而是使用提供者搜索端点。

返回 Promise

getFHIRResources

GET / fhir/{fhirVersion}/{resourceType}

返回资源类型的所有匹配 FHIR 资源 \ 也可以看看： \ 1upHealth 支持的 FHIR 版本和资源 https://1up.health/dev/reference/fhir-resources \ 官方 HL7 FHIR 文档 https://www.hl7.org/fhir

此端点以 http 承载身份验证标头的形式接收身份验证。

Parameters

• fhirVersion FHIRVersion
• resourceType (FHIRDSTU2.ResourceTypeStr | FHIRSTU3.ResourceTypeStr)
• queryParams QueryParams

返回 Promise包含所有内容的 FHIR 包与查询匹配的资源，

createFHIRResource

POST /fhir/{fhirVersion}/{resourceType}

可用于创建具有给定类型的 FHIR 资源。 \ 也可以看看： \ 1upHealth 支持的 FHIR 版本和资源 https://1up.health/dev/reference/fhir-resources \ 官方 HL7 FHIR 文档 https://www.hl7.org/fhir

Parameters

• fhirVersion FHIRVersion
• resourceType (FHIRDSTU2.ResourceTypeStr | FHIRSTU3.ResourceTypeStr)
• resource (FHIRDSTU2.Resource | FHIRSTU3.Resource)

返回 Promise包含已发布的所有属性的 FHIR 资源。

queryFHIREverything

GET /fhir/{fhirVersion}/Patient/{patientId}/$everything

此端点返回给定患者的所有已知 FHIR 资源的列表。 \ 这在传输批量数据或获取完整的患者病史时很有用。

Parameters

• patientId PatientId
• fhirVersion FHIRVersion

返回 Promise包含所有内容的 FHIR 包与查询匹配的资源

grantPermissions

PUT /fhir/dstu2/Patient/patientid/_permission/{oneUpUserId}

使用用户的 access_token 向 1upHealth FHIR API 发出请求时，\ 返回的资源将仅限于用户拥有的资源 \ 查看权限。 但是，有时在构建应用程序时您可能希望 \ 支持用户授予其他用户查看特定记录的权限。 \ 此端点允许您向任意用户授予对资源的访问权限。

Parameters

• oneUpUserId OneUpUserId
• fhirVersion FHIRVersion

返回 Promise

revokePermissions

DELETE / fhir/dstu2/Patient/patientid/_permission/{oneUpUserId}

此端点允许您删除已授予用户查看 \ 其他用户的 FHIR 资源。

Parameters

• oneUpUserId OneUpUserId
• fhirVersion FHIRVersion

返回 Promise

generateOAuth2Token

POST < a href="https://api.1up.health/fhir/oauth2/token">https://api.1up.health/fhir/oauth2/token

granttype=授权代码

此方法为给定的auth_code

Parameters

• authCode string

返回生成新的访问令牌Promise

refreshOAuth2Token

POST https://api.1up .health/fhir/oauth2/token

granttype=refreshtoken

此方法刷新给定 refresh_token 参数的访问令牌

Parameters

• refreshToken string

返回 Promise

authenticate

此方法生成访问令牌 对于 给定 appuserid。 \ 如果没有给定 appuser_id 的用户，它会创建一个新用户。

Parameters

• appUserId AppUserId

返回 Promise

HttpClient

HttpClient 是帮助程序抽象请求库。

defaultOptions

类型：HttpClientOptions

get

Parameters

• uri string
• options HttpClientOptions?

返回 Promise

post

Parameters

• uri string
• options HttpClientOptions?

返回 < strong>Promise

patch

Parameters

• uri string
• options HttpClientOptions?

返回 Promise

put

Parameters

• uri string
• options HttpClientOptions?

返回 Promise

delete

Parameters

• uri string
• options HttpClientOptions?

返回 Promise

Validator

getUsersPayload

Parameters

• oneUpUserId OneUpUserId?
• appUserId AppUserId?

createUserPayload

Parameters

• appUserId AppUserId
• userActive UserActive

updateUserPayload

Parameters

• appUserId AppUserId
• oneUpUserId OneUpUserId
• userActive UserActive

generateUserAuthCodePayload

Parameters

• appUserId AppUserId

accessToken

Parameters

• accessToken

clientKeys

Parameters

• $0 Object
  • $0.clientId
  • $0.clientSecret