Get Clinical Concept Care Team Member

Request

Retrieve a specific care team clinical concept associated with a subject by its ID.

Security

bearer

Path

idstringrequired

Query

subjectIdstringrequired

Subject ID (GUID)

Example:subjectId=123e4567-e89b-12d3-a456-426614174000

ProjectIdstring, (uuid)required

Example:e6b01018-a333-4732-917e-fe38e91b0fdf

curl -i -X GET \
  'https://partner.xcures.com/api/v1/patient-registry/clinical-concepts/care_team/{id}?subjectId=123e4567-e89b-12d3-a456-426614174000' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'ProjectId: e6b01018-a333-4732-917e-fe38e91b0fdf'

Responses

Bodyapplication/json

idstringrequired

Unique identifier for the care team member. Stable while the member's identity (NPI, else name) is unchanged; a member identified by name gets a new identifier once an NPI is found for them

documentIdsArray of stringsrequired

List of document IDs the care team member appears in, most recent document first

sourcestring

Source of the care team member record

npistring

The provider's National Provider Identifier. Only ever a valid NPI; absent when no document carries one

memberIdentityBasisstring

What the member's identity rests on: "npi" (a valid NPI) or "name" (the parsed, normalized name, when no mention carries a valid NPI)

displayNamestring

The provider's name as best rendered from the documents

namePrefixstring

Name prefix (e.g. Dr.)

firstNamestring

Provider first name

middleNamestring

Provider middle name

lastNamestring

Provider last name

nameSuffixstring

Name suffix (e.g. Jr.)

credentialsArray of strings

Credentials parsed from the provider's name (e.g. MD, NP)

specialtystring

The provider's specialty

specialtyCodestring

NUCC taxonomy code for the provider's specialty

careTeamRelationshipsArray of strings

The provider's role labels on the patient's care team (e.g. "Primary Care Provider")

participationRolesArray of strings

HL7 v3 participation type codes from the encounters and appointments the provider took part in (e.g. PRF, ATND)

participationRoleLabelsArray of strings

Labels for the participation codes, plus each procedure performer function (e.g. "attender", "Surgeon")

memberSourcesArray of strings

Where in the patient's records the provider was seen: any of "care_team", "encounter", "procedure", "plan_of_treatment"

affiliatedOrganizationNamestring

Organization the provider is affiliated with

contactAddressLinestring

Provider contact street address, from the most recent document that has one

contactCitystring

Provider contact city

contactStatestring

Provider contact state

contactPostalCodestring

Provider contact postal code

contactPhonestring

Provider contact phone number, from the most recent document that has one

contactFaxstring

Provider contact fax number, from the most recent document that has one

contactEmailstring

Provider contact email address, from the most recent document that has one

lastEncounterLocationNamestring

Name of the location of the provider's most recent encounter

lastEncounterLocationAddressLinestring

Street address of the location of the provider's most recent encounter

lastEncounterLocationCitystring

City of the location of the provider's most recent encounter

lastEncounterLocationStatestring

State of the location of the provider's most recent encounter

lastEncounterLocationPostalCodestring

Postal code of the location of the provider's most recent encounter

careTeamStartDatestring

Earliest start of the provider's care team membership (ISO string)

careTeamEndDatestring

Latest end of the provider's care team membership (ISO string)

firstEncounterDatestring

Date of the earliest encounter the provider took part in (ISO string)

lastEncounterDatestring

Date of the most recent encounter the provider took part in (ISO string)

firstSeenDatestring

Earliest date the provider appears on in the records: encounters, procedures, appointments or care team periods (ISO string)

lastSeenDatestring

Most recent date the provider appears on in the records (ISO string)

mostRecentDocumentDatestring

Date of the most recent document mentioning the provider (ISO string)

codesArray of objects(ClinicalConceptCareTeamCodeDto)

Specialty and role codes from source documents

Response

{
  "id": "string",
  "documentIds": [
    "string"
  ],
  "source": "string",
  "npi": "string",
  "memberIdentityBasis": "string",
  "displayName": "string",
  "namePrefix": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "nameSuffix": "string",
  "credentials": [
    "string"
  ],
  "specialty": "string",
  "specialtyCode": "string",
  "careTeamRelationships": [
    "string"
  ],
  "participationRoles": [
    "string"
  ],
  "participationRoleLabels": [
    "string"
  ],
  "memberSources": [
    "string"
  ],
  "affiliatedOrganizationName": "string",
  "contactAddressLine": "string",
  "contactCity": "string",
  "contactState": "string",
  "contactPostalCode": "string",
  "contactPhone": "string",
  "contactFax": "string",
  "contactEmail": "string",
  "lastEncounterLocationName": "string",
  "lastEncounterLocationAddressLine": "string",
  "lastEncounterLocationCity": "string",
  "lastEncounterLocationState": "string",
  "lastEncounterLocationPostalCode": "string",
  "careTeamStartDate": "string",
  "careTeamEndDate": "string",
  "firstEncounterDate": "string",
  "lastEncounterDate": "string",
  "firstSeenDate": "string",
  "lastSeenDate": "string",
  "mostRecentDocumentDate": "string",
  "codes": [
    { … }
  ]
}