These use cases will help you understand what information is being returned by the Provider Directory and Patient Access APIs.
Explanation for Practitioner resource from Provider Directory API:
https://api.geisinger.org/ghp/fhir4/providerdirectory/v1/Practitioner?name=PractitionerName
The above URL returns all information about a person formally involved in the healthCare process and healthCare- related services on behalf of a healthcare facility. Practitioners include and are not limited to physicians, nurses, pharmacists, therapists, technologists, and social workers. The Plan Net Practitioner API returns fields including Practitioner ID, NPI, Name, Address and profile information.
This API call will return a Practitioner resource data. Here is a subset of the data returned by this resource:
{
"resourceType": "Bundle",
"id": "f28add1d-9998-481e-9f05-8d074bd469b7",
"meta": {
"lastUpdated": "2021-04-23T15:39:57.873+00:00"
},
"type": "searchset",
"total": 96,
"link": [
{
"relation": "self",
"url": "https://api.geisinger.org/ghp/fhir4/providerdirectory/v1/Practitioner?_profile=http%3A%2F%2Fhl7.org%2Ffhir%2Fus%2Fdavinci-pdex-plan-net%2FStructureDefinition%2Fplannet-Practitioner&name=PractitionerName"
}
],
"entry": [
{
"fullUrl": "https://api.geisinger.org/ghp/fhir4/providerdirectory/v1/Practitioner/PractitionerName",
"resource": {
"resourceType": "Practitioner",
"id": "PractitionerID",
"meta": {
"versionId": "1",
"lastUpdated": "2020-08-21T00:06:22.740+00:00",
"profile": [
"http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"
],
"tag": [
{
"system": "tranzform-apim-request-ns",
"code": "user-request-id",
"display": "cc1f48c2-c9a9-4394-91ae-07433d17c65b\t\t\t1"
}
]
},
. . . . . . . . . .
Explanation for Patient resource from Patient Access API:
GET https://api.geisinger.org/ghp/fhir4/v1/Patient/[patient_id]
The above URL returns all of the member’s demographics and other administrative information as a Patient FHIR Resource. This information is mostly contact information, not medical data.
This API call will return a Patient resource. Here is a subset of the data returned by this resource:
{
"resourceType": "Patient",
"id": "PatientID",
"meta": {
"versionId": "1",
"lastUpdated": "2020-11-23T23:26:29.190+00:00",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
],
"tag": [
{
"system": "tranzform-apim-request-ns",
"code": "user-request-id",
"display": "1fb888bb-d0a3-49dc-a64b-d1fff9e01f9e\t\t\t1"
}
]
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "MedicalRecordNumber"
}
],
"text": "MedicalRecordNumber"
},
Explanation for Observation resource:
Observations are a central element in healthcare, used to support diagnosis, monitor progress, determine baselines and patterns and even capture demographic characteristics. This resource lets you obtain data for observation types such as vital signs, smoking data, and laboratory results.
In the synthetic data, there are synthetic members with the Vital Signs observation type.
Let us take a synthetic member record:
Username: SyntheticUsername
Password: SyntheticPassword
The Patient ID for this member is: PatientID
Let us do a simple Observation request for the preceding mentioned synthetic member: https://api.geisinger.org/ghp/fhir4/v1/Observation
Here’s the response:
{
"resourceType": "Bundle",
"id": "02d54614-154e-477d-8614-a8ddad1e46f2",
"meta": {
"lastUpdated": "2021-03-24T09:55:29.319+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=PatientID"
}
],
"entry": [
{
"fullUrl": "https://api.geisinger.org/ghp/fhir4/v1/Observation/ObservationID",
"resource": {
"resourceType": "Observation",
"id": "ObservationID",
"meta": {
"versionId": "1",
"lastUpdated": "2020-10-21T16:01:43.864+00:00",
"profile": [
"https://www.hl7.org/fhir/us/core/StructureDefinition-us-core-observation-lab"
],
"tag": [
{
"system": "tranzform-apim-request-ns",
"code": "user-request-id",
"display": "13182d5d-a006-46cd-96bc-a749f7d71ff5\t\t\t1"
}
]
}
. . . . .
The queries to reach each observation type individually, with combination parameters would be as follows:
Vital Signs: This profile returns data related to a member’s blood pressure and heart rate readings at their last doctor visit.
For a combination of patient and category:
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&category=[http://terminology.hl7.org/CodeSystem /observationcategory|vital-signs
For a combination of patient and code:
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&code=[system]|[code]
For a combination of patient, category and date:
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&category=[http://terminology.hl7.org/CodeSystem /observationcategory|vital-signs&date={gt|lt|ge|le}
Smoking Status:
This profile returns information on the smoking status of the patient, whether they are currently smoking or have smoked in the past.
For a combination of patient and category:
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&category=[http://terminology.hl7.org/CodeSystem /observationcategory|smoking-status
For a combination of patient and code:
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&code=[system]|[code]
For a combination of patient, category and date: https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&category=[http://terminology.hl7.org/CodeSystem /observationcategory|smoking-status&date={gt|lt|ge|le}
Laboratory Results
This profile returns information of a member’s test and result, or a nested set of tests, such as microbial susceptibility panel.
For a combination of patient and category
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&category=http://terminology.hl7.org/CodeSystem /observationcategory|laboratory
For a combination of patient and code:
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&code=[system]|code
For a combination of patient, category and date
https://api.geisinger.org/ghp/fhir4/v1/Observation?patient=[reference]&category=http://terminology.hl7.org/CodeSystem /observationcategory|laboratory&date={gt|lt|ge|le}[date]"