Health Profile¶

Sharecare's Health Profile is a comprehensive set of data driven features providing a simple and secure way to manage and store a user's health and wellness data. This includes supporting users' health data for populating health assessments as well as for targeting relevant health topics, news, and recommendations. In addition, the health profile provides a secure repository for users to track immunizations, lab results, conditions, medications, and procedures to provide a comprehensive view of their health history while also empowering users with the ability to share important information with healthcare providers to ensure they are receiving the best quality care.

Prerequisites

Before using Sharecare API's please read the API Integration Guide

Health Profile Biometrics Bulk Endpoint¶

Create new biometric record(s) for multiple users.

Sharecare’s Bulk Biometrics API services support the management of users’ biometric health data comprising of data such as blood pressure, cholesterol, glucose, BMI, and other standard biometric measurements reported during biometric screenings and health assessments. This includes the support for vitals data within the vitals end point for managing a user’s most recent set of standard biometric measurements.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L ''https://gateway.stage.sharecare.com/health-profile/biometrics/bulk' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \
-d '[
{
"transactionId": "1",
"account": {
"reference": "5a3f0e1d-87d8-4a19-aeb4-905c4d0b8251",
"type": "accountId"
},
"name": "Hemoglobin A1c",
"observationDate": "2024-03-28T09:29:14.770Z",
"codeSystem": "2.16.840.1.113883.6.1",
"codeSystemName": "LOINC",
"code": "4548-4",
"refHigh": 30,
"refLow": 0,
"refRange": "0-30",
"codes": [
{
"code": "4548-4",
"codeSystem": "2.16.840.1.113883.6.1",
"codeSystemName": "LOINC",
"name": "Hemoglobin A1c"
}
],
"type": "Observation",
"value": 6.2,
"unit": "%",
"source": {
"name": "Quest Diagnostics",
"type": "Clinical",
"notes": "Biometric Screening 20170921",
"meta": {
"batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
"dataQuality": "normalized",
"resourceKey": "12:80",
"sendingSystem": "SC_DHS",
"persistentRecordId": "103901287-C"
}
}
}
]'

Sample Response

{
"code": 201,
"message": "201 CREATED",
"data": [
    {
    "transactionId": "string",
    "account": {
    "reference": "1a0f14c5-d82c-4788-aa7f-66c82b5f67c5",
    "type": "partnerAccountId",
    "sponsor": "string"
    },
    "name": "string",
    "source": {
    "name": "string",
    "notes": "string",
    "type": "string",
    "meta": {
    "dataQuality": "normalized"
    }
    },
    "observationDate": "2024-04-03T11:53:36.571Z",
    "value": 0.1,
    "unit": "string",
    "codes": [
    {
    "code": "string",
    "codeSystem": "string",
    "codeSystemName": "string",
    "name": "string"
    }
    ]
    }
    ]

Health Profile Biometrics Endpoint¶

Create new biometric record(s) for single user.

Sharecare’s Biometrics API services support the management of users’ biometric health data comprising of data such as blood pressure, cholesterol, glucose, BMI, and other standard biometric measurements reported during biometric screenings and health assessments. This includes the support for vitals data within the vitals end point for managing a user’s most recent set of standard biometric measurements.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L ''https://gateway.stage.sharecare.com/health-profile/biometrics' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \
-d '[
{
"transactionId": "1",
"account": {
"reference": "5a3f0e1d-87d8-4a19-aeb4-905c4d0b8251",
"type": "accountId"
},
"name": "Hemoglobin A1c",
"observationDate": "2024-03-28T09:29:14.770Z",
"codeSystem": "2.16.840.1.113883.6.1",
"codeSystemName": "LOINC",
"code": "4548-4",
"refHigh": 30,
"refLow": 0,
"refRange": "0-30",
"codes": [
{
"code": "4548-4",
"codeSystem": "2.16.840.1.113883.6.1",
"codeSystemName": "LOINC",
"name": "Hemoglobin A1c"
}
],
"type": "Observation",
"value": 6.2,
"unit": "%",
"source": {
"name": "Quest Diagnostics",
"type": "Clinical",
"notes": "Biometric Screening 20170921",
"meta": {
"batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
"dataQuality": "normalized",
"resourceKey": "12:80",
"sendingSystem": "SC_DHS",
"persistentRecordId": "103901287-C"
}
}
}
]'

Sample Response

{
"code": 201,
"message": "201 CREATED",
"data": [
    {
    "transactionId": "string",
    "account": {
    "reference": "1a0f14c5-d82c-4788-aa7f-66c82b5f67c5",
    "type": "partnerAccountId",
    "sponsor": "string"
    },
    "name": "string",
    "source": {
    "name": "string",
    "notes": "string",
    "type": "string",
    "meta": {
    "dataQuality": "normalized"
    }
    },
    "observationDate": "2024-04-03T11:53:36.571Z",
    "value": 0.1,
    "unit": "string",
    "codes": [
    {
    "code": "string",
    "codeSystem": "string",
    "codeSystemName": "string",
    "name": "string"
    }
    ]
    }
    ]

Health Profile Get Biometrics Endpoint¶

Retrieves a list of biometric records for a specified user. It will return the latest records (by observationDate) based on code and sourceType.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L 'https://gateway.stage.sharecare.com/health-profile/biometrics?entity=https%3A%2F%2Fauth.qa.sharecare.com%2Faccount%2F64ad4bbe-7829-4924-b630-e2b1898b0ab1&accountReference=64ad4bbe-7829-4924-b630-e2b1898b0ab1&accountReferenceType=partnerAccountId' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \

Sample Response

{
"code": "200",
"message": "Success",
"data": [
    {
        "id": "ab20decf-c56f-42f5-96e8-12215a1d44eb",
        "accountReference": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "created": "1711619485936",
        "updated": "1711619485936",
        "name": "Hemoglobin A1c",
        "source": {
            "name": "Quest Diagnostics",
            "type": "Clinical",
            "notes": "Biometric Screening 20170921",
            "meta": {
                "dataQuality": "normalized",
                "batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
                "resourceKey": "12:80",
                "sendingSystem": "SC_DHS",
                "persistentRecordId": "103901287-C"
            }
        },
        "observationDate": "1637111462000",
        "value": 6.2,
        "unit": "%",
        "codes": [
            {
                "code": "4548-4",
                "codeSystem": "2.16.840.1.113883.6.1",
                "codeSystemName": "LOINC",
                "name": "Hemoglobin A1c"
            }
        ]
    },
    {
        "id": "00c20e39-68a8-4e0e-b9b7-69a17beab499",
        "accountReference": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "created": "1708068992763",
        "updated": "1708068992763",
        "name": "Hemoglobin A1c",
        "source": {
            "name": "1234",
            "type": "12345",
            "notes": "Biometric Screening 20170921",
            "meta": {
                "dataQuality": "normalized",
                "batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
                "resourceKey": "12:80",
                "sendingSystem": "SC_DHS",
                "persistentRecordId": "103901287-C"
            }
        },
        "observationDate": "1637111462000",
        "value": 6.2,
        "unit": "%",
        "codes": [
            {
                "code": "4548-4",
                "codeSystem": "2.16.840.1.113883.6.1",
                "codeSystemName": "LOINC",
                "name": "Hemoglobin A1c"
            }
        ]
    },
    {
        "id": "fdfa4203-1b1f-496e-ba43-7dd9a3e65c0a",
        "accountReference": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "created": "1703055259151",
        "updated": "1703055259151",
        "name": "Hemoglobin A1c",
        "source": {
            "name": "123456",
            "type": "123456789",
            "notes": "Biometric Screening 20170921",
            "meta": {
                "dataQuality": "normalized",
                "batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
                "resourceKey": "12:80",
                "sendingSystem": "SC_DHS",
                "persistentRecordId": "103901287-C"
            }
        },
        "observationDate": "1637111462000",
        "value": 6.2,
        "unit": "%",
        "codes": [
            {
                "code": "4548-4",
                "codeSystem": "2.16.840.1.113883.6.1",
                "codeSystemName": "LOINC",
                "name": "Hemoglobin A1c"
            }
        ]
    },
    {
        "id": "1ba4c325-6ef7-4e5e-9529-cdd5c9812115",
        "accountReference": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "created": "1702646989000",
        "updated": "1702646989000",
        "name": "Hemoglobin A1c",
        "source": {
            "name": "99879",
            "type": "98009",
            "notes": "Biometric Screening 20170921",
            "meta": {
                "dataQuality": "normalized",
                "batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
                "resourceKey": "12:80",
                "sendingSystem": "SC_DHS",
                "persistentRecordId": "103901287-C"
            }
        },
        "observationDate": "1637111462000",
        "value": 6.2,
        "unit": "%",
        "codes": [
            {
                "code": "4548-4",
                "codeSystem": "2.16.840.1.113883.6.1",
                "codeSystemName": "LOINC",
                "name": "Hemoglobin A1c"
            }
        ]
    },
    {
        "id": "dcf352f9-be15-4ecd-9c6e-08f3d71e7a4c",
        "accountReference": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "created": "1702639957133",
        "updated": "1702639957133",
        "name": "Hemoglobin A1c",
        "source": {
            "name": "8796",
            "type": "9886",
            "notes": "Biometric Screening 20170921",
            "meta": {
                "dataQuality": "normalized",
                "batchId": "f5a64c19-7b40-4445-bfec-71aa280a95d2|1",
                "resourceKey": "12:80",
                "sendingSystem": "SC_DHS",
                "persistentRecordId": "103901287-C"
            }
        },
        "observationDate": "1637111462000",
        "value": 6.2,
        "unit": "%",
        "codes": [
            {
                "code": "4548-4",
                "codeSystem": "2.16.840.1.113883.6.1",
                "codeSystemName": "LOINC",
                "name": "Hemoglobin A1c"
            }
        ]
    }
],
"errors": []
}

Health Profile Get Conditions Endpoint¶

Retrieves a list of condition records for a specified user. It will return the latest records (by observationDate) based on code and sourceType.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L 'https://gateway.stage.sharecare.com/health-profile/conditions?accountReference=64ad4bbe-7829-4924-b630-e2b1898b0ab1&accountReferenceType=partnerAccountId' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \

Sample Response

{
"data": {
"code": "200",
"message": "Success",
"data": [
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "20256788999",
        "source": {
            "name": "string",
            "type": "string",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1700832637736",
        "updateDate": "1700832637736"
    },
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "1234567",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "9889",
            "type": "989",
            "notes": "6785",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1702647429408",
        "updateDate": "1702647429408"
    },
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "",
            "type": "",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1702554015099",
        "updateDate": "1702554015099"
    },
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "34567",
            "type": "345678",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1702553839564",
        "updateDate": "1702553839564"
    }
],
"errors": []
}

Health Profile Create Conditions Endpoint¶

Create new condition record(s) for single users. If you wish to validate your records, add source.meta.dataQuality:normalized` in your body for each record. All dates are normalized to and expressed in the UTC timezone.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L ''https://gateway.stage.sharecare.com/health-profile/conditions' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \
-d '[
    {
    "transactionId": "1",
    "account": {
    "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1",
    "type": "partnerAccountId"
    },
    "name": "string",
    "status": "string",
    "source": {
    "name": "string",
    "notes": "string",
    "type": "string",
    "meta": {
    "dataQuality": "normalized"
    }     
    },
    "observationDate": 12132232323,
    "medication": [{
    "code": "string",
    "codeSystem": "string",
    "codeSystemName": "string",
    "name": "string"
    }],
    "family": {
    "history": "string",
    "member": [
    "string"
    ]
    },
    "codes": [
    {
    "code": "string",
    "codeSystem": "string",
    "codeSystemName": "string",
    "name": "string"
    }
    ]
    }
    ]'

Sample Response

{
"code": "200",
"message": "Success",
"data": [
    {
        "account": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "string",
            "type": "string",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1713174556589",
        "updateDate": "1713174556589",
        "id": "d42c7add-5404-49d5-b24f-644f1eabb12a"
    }
],
"errors": []
}

Health Profile Create Conditions Bulk Endpoint¶

Create new condition record(s) for multiple users. If you wish to validate your records, add source.meta.dataQuality:normalized` in your body for each record. All dates are normalized to and expressed in the UTC timezone.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L ''https://gateway.stage.sharecare.com/health-profile/conditions/bulk' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-d '[
    {
    "transactionId": "1",
    "account": {
    "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1",
    "type": "partnerAccountId"
    },
    "name": "string",
    "status": "string",
    "source": {
    "name": "string",
    "notes": "string",
    "type": "string",
    "meta": {
    "dataQuality": "normalized"
    }     
    },
    "observationDate": 12132232323,
    "medication": [{
    "code": "string",
    "codeSystem": "string",
    "codeSystemName": "string",
    "name": "string"
    }],
    "family": {
    "history": "string",
    "member": [
    "string"
    ]
    },
    "codes": [
    {
    "code": "string",
    "codeSystem": "string",
    "codeSystemName": "string",
    "name": "string"
    }
    ]
    }
    ]'

Sample Response

{
"code": "200",
"message": "Success",
"data": [
    {
        "account": {
            "type": "accountId",
            "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "string",
            "type": "string",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1713174556589",
        "updateDate": "1713174556589",
        "id": "d42c7add-5404-49d5-b24f-644f1eabb12a"
    }
],
"errors": []
}

Health Profile Create Care Teams Endpoint¶

Create new care teams record(s) for a user.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L ''https://gateway.stage.sharecare.com/health-profile/care-teams' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \
-d '[
{
    "account": {
        "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1",
        "type": "accountId"
    },
    "name": "Jenny Sue",
    "profile": "http://www.wellnessworld.com/Jenny",
    "phoneNumber": "404-555-232a3",
    "type": "Health Coach",
    "location": "Wellness World",
    "address": "1968 Peachtree St NW",
    "city": "Atlanta",
    "zip": "30309",
    "npi": "0987654321",
    "observationDate": "1496417540470",
    "source": {
        "name": "Quest Diagnostics",
        "type": "Clinical",
        "notes": "Biometric Screening 2017-03-18",
        "meta": {
            "batchId": "f55b49c2-4ac4-11e7-a919-92ebcb67fe33|1",
            "dataQuality": "normalized",
            "resourceKey": "12:80",
            "sendingSystem": "SC_DHS",
            "persistentRecordId": "103901287"
        }
    }
}
]'

Sample Response

{
"code": "200",
"message": "Success",
"data": [
    {
        "id": "8a0c5d0f-e9f8-4061-abe6-89ca154194b2",
        "userId": "64ad4bbe-7829-4924-b630-e2b1898b0ab1",
        "profile": "http://www.wellnessworld.com/Jenny",
        "createDate": "1713176164005",
        "updateDate": "0",
        "name": "Jenny Sue",
        "npi": "0987654321",
        "zip": "30309",
        "city": "Atlanta",
        "address": "1968 Peachtree St NW",
        "location": "Wellness World",
        "phoneNumber": "404-555-232a3",
        "type": "Health coach",
        "pcp": false,
        "observationDate": 1496417540470,
        "source": {
            "name": "Quest Diagnostics",
            "type": "Clinical",
            "notes": "Biometric Screening 2017-03-18",
            "meta": {
                "dataQuality": "normalized",
                "batchId": "f55b49c2-4ac4-11e7-a919-92ebcb67fe33|1",
                "resourceKey": "12:80",
                "sendingSystem": "SC_DHS",
                "persistentRecordId": "103901287"
            }
        },
        "hydrateCareTeams": false
    }
],
"errors": []
}

Health Profile Get Care Teams¶

Retrieves a list of care team records for a specified user.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L 'https://gateway.stage.sharecare.com/health-profile/conditions?accountReference=64ad4bbe-7829-4924-b630-e2b1898b0ab1&accountReferenceType=partnerAccountId' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \

Sample Response

{
"data": {
"code": "200",
"message": "Success",
"data": [
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "20256788999",
        "source": {
            "name": "string",
            "type": "string",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1700832637736",
        "updateDate": "1700832637736"
    },
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "1234567",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "9889",
            "type": "989",
            "notes": "6785",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1702647429408",
        "updateDate": "1702647429408"
    },
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "",
            "type": "",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1702554015099",
        "updateDate": "1702554015099"
    },
    {
        "account": {
            "type": "entity",
            "reference": "https://auth.qa.sharecare.com/account/64ad4bbe-7829-4924-b630-e2b1898b0ab1"
        },
        "name": "string",
        "codes": [
            {
                "code": "string",
                "codeSystem": "string",
                "codeSystemName": "string",
                "name": "string"
            }
        ],
        "observationDate": "12132232323",
        "source": {
            "name": "34567",
            "type": "345678",
            "notes": "string",
            "meta": {
                "dataQuality": "normalized"
            }
        },
        "createDate": "1702553839564",
        "updateDate": "1702553839564"
    }
],
"errors": []
}

Health Profile Delete CareTeams Endpoint¶

DELETE all careteam(s) identified by parameter id or npi - may be specified multiple times. At least 1 id or npi must be provided. When an object is deleted the result is 204 and if no object is deleted a 404, unless an error occurred.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -X "DELETE" ''https://gateway.stage.sharecare.com/health-profile/care-teams?npi=0987654321&accountReference=1a0f14c5-d82c-4788-aa7f-66c82b5f67c5&accountReferenceType=partnerAccountId' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \

Health Profile Set PCP Endpoint¶

Set Primary care physician within the user’s care-teams. You need to pass in the id or npi field. The other care-teams pcp from the same user will be unset.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -L ''https://gateway.stage.sharecare.com/health-profile/care-teams/pcp' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \
-d '{
"account": {
    "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1",
    "type": "accountId"
},
"npi": "0987654321"
}'

Sample Response

{
"code": "200",
"message": "Success",
"data": [
    {
        "npi": "0987654321"
    }
],
"errors": []
}

Health Profile Unset PCP Endpoint¶

Removes PCP from a care-teams object by either id or npi.

API

API Documentation¶

Refer to our API documentation for the most up to date specifications.

Simply click "Try it out" then "Execute" with the default values to see a live response.

Open API Doc

Open In a New Window

Example¶

Try out the curl as is for a static response OR Replace '5nLpWr' with your API key

Request

curl -X "DELETE" ''https://gateway.stage.sharecare.com/health-profile/care-teams/pcp' \
-H 'Content-Type: application/json;charset=UTF-8' \
-H 'X-API-Key: 5nLpWr' \
-H 'Authorization: Bearer token' \
-d '{
"account": {
    "reference": "64ad4bbe-7829-4924-b630-e2b1898b0ab1",
    "type": "accountId"
},
"npi": "0987654321"
}'

Sample Response

{
"code": "200",
"message": "Success",
"data": [
    {
        "npi": "0987654321"
    }
],
"errors": []
}