Introduction
This guide is written for third party developers, including patients, who are developing software applications for accessing Protected Health Information (PHI) based on this documentation of an open API. This document will describe registration, syntax, functionality and errors/exceptions they will see when using the FHIR API according to the FHIR Release 4 specifications https://www.hl7.org/fhir/ to integrate with provider(s) using the Agastha Software. Please refer to https://agastha.com/api-terms.html for the terms of use.
All API access is over https. All data is sent and received as JSON. The API supports R4 FHIR standard defined media type for JSON content : application/fhir+json
US Core Version : US Core 5.0.1 / USCDI v2
SMART App Launch Version : SMART App Launch 2.0.0
Bulk Data Version : Bulk Data 2.0.0
Root URL
Sandbox : https://demo1.agastha.com/AgAPI
Registration
SMART on FHIR applications need to be registered with Agastha before they can be used. To start the registration process, please submit a request by filling out this form
https://demo1.agastha.com/AgAPI/AppRegister
Agastha will validate your request based on the information submitted. After successful registration you will get an activation link by email to verify your account. You may click the activation link to verify your account. If you are approved you will receive an OAuth Client ID, Secret Key in email which can be used on subsequent requests following the protocols specified in the official SMART App Authorization Guide.
Authentication
Agastha APIs are authenticated using the OAuth 2.0 protocol. All API requests must include an Authorization header with an Access Token of the form :
Authorization : Bearer MY_ACCESS_TOKEN
Validation
When making create or update requests to the FHIR server the payloads will be validated according to the FHIR Release 4 specifications https://www.hl7.org/fhir/. Any get or search requests will return payloads that conform to the FHIR specifications
Capability Statement
The Capability Statement describes the FHIR server's functionality, including the resource types that the server supports.
Authorization OAuth 2.0
Well-known configuration endpoint
In order to obtain launch context and request authorization to access FHIR resources, the app discovers the EHR FHIR server's SMART configuration metadata, including OAuth authorization_endpoint and token_endpoint URLs.
The discovery URL is constructed by appending .well-known/smart-configuration to the FHIR Base URL. The app issues an HTTP GET to the discovery URL with an Accept header supporting application/json.
GET [base]/.well-known/smart-configuration
Success Response
{
"authorization_endpoint": "[base]/oauth/authorization",
"registration_endpoint": "[base]/AppRegister",
"token_endpoint": "[base]/oauth/token",
"revocation_endpoint": "[base]/oauth/token/revoke-token",
"token_endpoint_auth_methods_supported": [
"client_secret_basic",
"private_key_jwt"
],
"token_endpoint_auth_signing_alg_values_supported": [
"RS384",
"ES384"
],
"scopes_supported": [
"launch",
"profile",
"fhirUser",
"openid",
"online_access",
"offline_access",
"user/AllergyIntolerance.read",
"patient/AllergyIntolerance.read",
"system/AllergyIntolerance.read",
"user/Binary.read",
"patient/Binary.read",
"system/Binary.read",
"user/CarePlan.read",
"patient/CarePlan.read",
"system/CarePlan.read",
"user/CareTeam.read",
"patient/CareTeam.read",
"system/CareTeam.read",
"user/Condition.read",
"patient/Condition.read",
"system/Condition.read",
"user/Device.read",
"patient/Device.read",
"system/Device.read",
"user/DiagnosticReport.read",
"patient/DiagnosticReport.read",
"system/DiagnosticReport.read",
"user/DocumentReference.read",
"patient/DocumentReference.read",
"system/DocumentReference.read",
"user/Encounter.read",
"patient/Encounter.read",
"system/Encounter.read",
"user/Goal.read",
"patient/Goal.read",
"system/Goal.read",
"user/Immunization.read",
"patient/Immunization.read",
"system/Immunization.read",
"user/Location.read",
"system/Location.read",
"user/MedicationRequest.read",
"patient/MedicationRequest.read",
"system/MedicationRequest.read",
"user/Medication.read",
"patient/Medication.read",
"system/Medication.read",
"user/Observation.read",
"patient/Observation.read",
"system/Observation.read",
"user/Organization.read",
"system/Organization.read",
"user/Patient.read",
"patient/Patient.read",
"system/Patient.read",
"user/Practitioner.read",
"system/Practitioner.read",
"user/Procedure.read",
"patient/Procedure.read",
"system/Procedure.read",
"user/Provenance.read",
"patient/Provenance.read",
"system/Provenance.read",
"user/RelatedPerson.read",
"patient/RelatedPerson.read",
"system/RelatedPerson.read",
"user/ServiceRequest.read",
"patient/ServiceRequest.read",
"system/ServiceRequest.read"
],
"response_types_supported": [
"code"
],
"grant_types_supported":[
"authorization_code",
"implicit",
"password",
"client_credentials",
"urn:ietf:params:oauth:grant-type:jwt-bearer"
],
"code_challenge_methods_supported":[
"S256"
],
"issuer":"[base]",
"jwks_uri":"[base]/oauth/jwks",
"management_endpoint": "[base]/provider/my-authorizations",
"introspection_endpoint": "[base]/tokeninfo",
"capabilities": [
"launch-ehr",
"launch-standalone",
"client-public",
"client-confidential-symmetric",
"sso-openid-connect",
"context-standalone-patient",
"authorize-post",
"permission-v1",
"permission-v2",
"context-banner",
"context-style",
"context-ehr-patient",
"context-ehr-encounter",
"permission-patient",
"permission-user",
"permission-offline",
"health-cards"
]
}
Authorization Endpoint
To proceed with a launch, the app constructs a request for an authorization code.The app supplies the following parameters to the EHR's "authorize" endpoint.
GET/POST [base]/oauth/authorization
| response_type | required | Fixed value: code. |
| client_id | required | The client's identifier. |
| redirect_uri | required | Must match one of the client's pre-registered redirect URIs. |
| launch | conditional | When using the EHR Launch flow, this must match the launch value received from the EHR. Omitted when using the Standalone Launch. |
| scope | required | Must describe the access that the app needs, including scopes like patient/*.rs, openid and fhirUser (if app needs authenticated patient identity) and either: a launch value indicating that the app wants to receive already-established launch context details from the EHR a set of launch context requirements in the form launch/patient, which asks the EHR to establish context on your behalf. |
| state | required | An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter SHALL be used for preventing cross-site request forgery or session fixation attacks. The app SHALL use an unpredictable value for the state parameter with at least 122 bits of entropy (e.g., a properly configured random u uid is suitable). |
| aud | required | URL of the EHR resource server from which the app wishes to retrieve FHIR data. This parameter prevents leaking a genuine bearer token to a counterfeit resource server. (Note that in the case of an EHR launch flow, this aud value is the same as the launch's iss value.) Note that the aud parameter is semantically equivalent to the resource parameter defined in RFC8707. SMART's aud parameter predates RFC8707 and we have decided not to rename it for reasons of backwards compatibility. We might consider renaming SMART's aud parameter in the future if implementer feedback indicates that alignment would be valuable. For the current release, servers SHALL support the aud parameter and MAY support a resource parameter as a synonym for aud. |
| code_challenge | required | This parameter is generated by the app and used for the code challenge, as specified by PKCE. For example, when code_challenge_method is 'S256', this is the S256 hashed version of the code_verifier parameter. See considerations-for-pkce-support. |
| code_challenge_method | required | Method used for the code_challenge parameter. Example value: S256. See considerations-for-pkce-support. |
2.1 Example
GET [base]/oauth/authorization
Parameters :
response_type=code&client_id=CLIENT_ID&redirect_uri=https%3A%2F%2Finferno.healthit.gov%2Fsuites%2Fcustom%2Fsmart%2Fredirect&scope=launch%2Fpatient+openid+fhirUser+offline_access+patient%2FMedication.rs+patient%2FAllergyIntolerance.rs+patient%2FCarePlan.rs+patient%2FCareTeam.rs+patient%2FCondition.rs+patient%2FDevice.rs+patient%2FDiagnosticReport.rs+patient%2FDocumentReference.rs+patient%2FEncounter.rs+patient%2FGoal.rs+patient%2FImmunization.rs+patient%2FLocation.rs+patient%2FMedicationRequest.rs+patient%2FObservation.rs+patient%2FOrganization.rs+patient%2FPatient.rs+patient%2FPractitioner.rs+patient%2FProcedure.rs+patient%2FProvenance.rs+patient%2FPractitionerRole.rs+patient%2FServiceRequest.rs&state=dae471ce-d6c6-409e-a7a8-5732356b6e4f&aud=https%3A%2F%2Fdemo1.agastha.com%2FAgAPI&code_challenge=TP46qIhnKZvVyCYMrZTyibKT_dYlnrcm8KnWHeXV-hk&code_challenge_method=S256
Token Endpoint
After obtaining an authorization code, the app trades the code for an access token. The app issues an HTTP POST to the EHR authorization server's token endpoint URL using content-type application/x-www-form-urlencoded.
POST [base]/oauth/token
3.1 Example for Access Token By Authorization Code :
Parameters :
| grant_type | required | Fixed value: authorization_code |
| code | required | Code that the app received from the authorization server |
| redirect_uri | required | The same redirect_uri used in the initial authorization request |
| code_verifier | required | This parameter is used to verify against the code_challenge parameter previously provided in the authorize request. |
| client_id | conditional | Required for public apps. Omit for confidential apps. |
For public apps, authentication not required because a client with no secret cannot prove its identity when it issues a call. (The end-to-end system can still be secure because the client comes from a known, https protected endpoint specified and enforced by the redirect uri.) For confidential apps, authentication is required.
Example For Authorization Header :
If the client_id is "my-app" and the client_secret is "my-app-secret-123", then the header uses the value B64Encode("my-app:my-app-secret-123"), which converts to bXktYXBwOm15LWFwcC1zZWNyZXQtMTIz. This gives the app the Authorization token for "Basic Auth".
Authorization : Basic bXktYXBwOm15LWFwcC1zZWNyZXQtMTIz
POST: [base]/oauth/token
Parameters :
code=b0d08fc300b6f37565fa0166599431da&code_verifier=810b6803-badd-4f68-a7cb-0963d40cf77b-56053f59-cae3-4c4b-bb88-37391c7f1cff&grant_type=authorization_code&redirect_uri=https%3A%2F%2Finferno.healthit.gov%2Fsuites%2Fcustom%2Fsmart%2Fredirect
Success Response :
{
"access_token": "f0cc3d6f65d6bd51d905fbc4a1d9c913",
"refresh_token": "6570ea63dadcb841aff760f115751a13",
"patient": "100126",
"need_patient_banner": "true",
"scope": "launch/patient openid fhirUser offline_access patient/Medication.rs patient/AllergyIntolerance.rs patient/CarePlan.rs patient/CareTeam.rs patient/Condition.rs patient/Device.rs patient/DiagnosticReport.rs patient/DocumentReference.rs patient/Encounter.rs patient/Goal.rs patient/Immunization.rs patient/Location.rs patient/MedicationRequest.rs patient/Observation.rs patient/Organization.rs patient/Patient.rs patient/Practitioner.rs patient/Procedure.rs patient/Provenance.rs patient/PractitionerRole.rs patient/ServiceRequest.rs",
"id_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiI1NjhhY2M4ZS1jMzBiLTRjMTQtOTg5OC01YzFlOGNmN2FjNmQiLCJhdWQiOiJoYW51bWFudGgxIiwiaXNzIjoiaHR0cHM6Ly9kZW1vMS5hZ2FzdGhhLmNvbS9BZ0FQSSIsImZoaXJVc2VyIjoiaHR0cHM6Ly9kZW1vMS5hZ2FzdGhhLmNvbS9BZ0FQSS9QYXRpZW50LzEwMDEyNiIsImp0aSI6IjI1NzlkZjI0LTNlZmQtNDhjOC04YmYxLTU1M2E5ODY0ZGY4NCIsImlhdCI6MTY2ODQxMDU3MiwiZXhwIjoxNjY4NDEwODcyfQ.POVhalzNilSjvRkhmA_tqrxkj5ukLFvLAV0uUcK240rLlsAd70j88mphILqiaW-tz9Vks5yEPBbB8lMyFTIPPBFsOeGMkA3tK0feuEevKRXON6ywo2lLeJtHSyug5L1y2Qpk6gyYQzgCpR9u_96CN-TZNXmX3DXbnFJJtIJBzSNkjOpSTsvPQixOXWEQdibmNdaIZY-DtCG1oI238JI1hhReRD4JF9lF0wRdNH0KeiJufCgWSzQzNonc1fhNNgtFP1bcWKGIr6c33x-d9WJldYNVV5Gcc82obZY_VVCRTpk6E4HT4w0vORDIsoXxXRXkii9wmfc4H8WlGlnFO7IHGA",
"smart_style_url": "https://demo1.agastha.com/demo1/AgAPI/smart_v1",
"encounter": "30320",
"token_type": "Bearer",
"expires_in": 3600
}OpenID Configuration
OpenID Connect (OIDC) provides the ability to verify the identity of the authorizing user. Within the SMART App Launch Framework, Applications can request an id_token be provided with by including the openid fhirUser scopes when requesting authorization.
GET: [base]/.well-known/openid-configuration
Success Response :
{
"response_types_supported": [
"code",
"id_token",
"token id_token"
],
"jwks_uri": "[base]/.well-known/jwk",
"subject_types_supported": [
"pairwise",
"public"
],
"id_token_signing_alg_values_supported": [
"RS256"
],
"issuer": "[base]",
"authorization_endpoint": "[base]/oauth/authorizationredirect",
"token_endpoint": "[base]/oauth/token"
}
jwks uri
GET [base]/.well-known/jwk
Success Response :
{
"keys": [
{
"p": "7ScsDCL7omoXj4lVMt9RkWp6wQ8WDu5M-OCDrcM1_lfyta2wf7-9hv7iDb-FwQnWO3W7eFngYUTwSw5xYP2uvOL5qbe7YntKI4Q9gHgUd4XdRJJSIdcoY9_d1pavkYwOGk7KsUrmSeoJJ2Jg54ypVzZlVRkcHjuwiiXKvHwj2-U",
"kty": "RSA",
"q": "2w5YvWSujExREmue0BOXtypOPgxuolZYpS5LnuAr4rvrZakE8I4sdYjh0yLZ6qXJHzVlxW3DhTqhcrhTLhd54YDogy2IT2ff0GzAV0kX-nz-mRhw0_u-Yw6h0QuzH9Q04Wg3T_u_K9-rG335j_RU1Tnh7nxetfGbEwJ1oOqcXik",
"d": "oE9eIpF1qEzOUn16XJHKuaeKFfsKvjWTuHABL6pJ60KSm7pGPKQUK-qCMKkX62_J_8N93JsXSY8FK2uWQiPWIfb1gF3XpA9JlHs2SmuegB2DOXfPIaBxGFGN9fKtqNkoQnbzWzRRrn-LnqRd2XBj9olethptzHA69uchc3GGpZg1J6Nmfvl9xpxLK9q55E7o2rGYJMEbYg7gUNz_EbOzIUog5VhL4Hij-S1Q6VTcpt-_C3PtTkYCH2akUX4OSvvsq_eLZpBSieNrqKztfcmUD3d0-7gkNYryOuGB1mpj2n1Dyh1sphRoFXxnwKc2DPbNo1CKeyHPA54Z8WWx3oftIQ",
"e": "AQAB",
"use": "sig",
"kid": "9da3c96f-4758-4232-971c-94797724d6d2",
"qi": "Zo11s4GrE-yXB6z-9n6qxMeHIP40BTZajgzW-debX10gQaABYmsViSt1If-tPyOnBS_0KJ3q-LazQ1kjaGBDQaly2Z1hnyKNLwCIJ4iejg-u_tYRELW3p4Un3hPB6LtgZxTk2o1MZmIBpt_ocYfEzzr3xwE3YsCJu0Lu-oB4ac0",
"dp": "qBAWmxM_mL3urH36ru6r842uKJr0WuhuDAGvz7iDzxesnSvV5PKQ8dY3hN6xfzflZoXssUGgTc55K_e0SbP93UZNAAWA-i29QKY6n4x5lKp9QFchdXHw4baIk8Z97Xt_kw07f6FAyijdC9ggLHf2miOmdEQzNQm_9mcJ4cFn-DE",
"dq": "gvOepQntNr3gsUxY0jcEOWE3COzRroZD0-tLFZ0ZXx_L5ygVZeD4PwMnTNrGvvmAtAFt54pomdqk7Tm3sBQkrmQrm0-67w0_xQ9eJE_z37CdWtQ7jt4twHXc0mVWHa70NdPhTRVIAWhil7rFWANOO3Gw2KrMy6O1erW7sAjQlZE",
"n": "yu3NB7Tr3nzETLNbZHYiZvgNeg3_OZUJZl40LzBzYGOD_8575eJETjfQ3QXaNyvNThu6Uf9B_V73QUxKI4_-rwlbjA3niIga4MdDiY4b9K_KFA-HedvtZF1yE2p4smXGydPLOLBe31EgriGTob78EE3f7SMFxlNaqn4Pm7KJkOodnMz0ilwLseeL1IkTtiFn_2OrcMpPHMtTxyDn3pQlVCeJM5j_grDh-0YdyTMGdDHOBgM53VqSsDVyo1TNtP2yhPRYCIiI85hEHVaUnVM9jGwCjNZLJHWh10Mrmh6B3z8BEmLhMAZXeL4fQBjBd42DLvIIJwM1USKFhjK-XghNrQ"
}
]
}
Revocation Endpoint
The Token Revocation extension defines a mechanism for clients to indicate to the authorization server that an access token is no longer needed. This is used to enable a "log out" feature in clients, allowing the authorization server to clean up any security credentials associated with the authorization.
POST [base]/oauth/token/revoke-token
Example :
[base]/oauth/token/revoke-token
Parameters :
token=e8961aaf31be25b173edcd4b64b4522d
Success Response :
Response Status : 200 with empty body
Alternate Way :
[base]/oauth/token/revoke-token
Resources
Response Codes :
| Code | Response | Description |
| 200 | Success | Request is successfully fulfilled |
| 400 | Bad Request | Invalid request(Parameters/heades) |
| 401 | Access Denied | Authentication failure |
| 403 | Forbidden | Unauthorized(scope issue/access problem) |
| 500 | Internal server Error | Problem on server side |
AllergyIntolerance
| Method | EndPoint | Description |
| GET | [BaseURL]/AllergyIntolerance | Returns the allergies for a specific patient |
| Parameter | Mandatory | Description |
| Patient | Yes | Patient Acct# |
Example:
Request
GET [BaseURL]/AllergyIntolerance?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "7900d6fc-22a1-4b33-9f21-3b4b94aacd33",
"meta": {
"lastUpdated": "2023-10-03T09:06:28.255-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/AllergyIntolerance?patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/AllergyIntolerance/11605",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "11605",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"category": [
"medication"
],
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "Penicillin G"
}
]
},
"patient": {
"reference": "Patient/100126"
},
"onsetPeriod": {
"start": "2016-04-04T00:00:00-04:00"
},
"recordedDate": "2018-04-24T00:00:00-04:00",
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"display": "Hives"
}
],
"text": "Hives"
}
],
"severity": "mild"
}
]
}
},
{
"fullUrl": "[BaseURL]/AllergyIntolerance/11606",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "11606",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"category": [
"medication"
],
"code": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"display": "Codeine"
}
]
},
"patient": {
"reference": "Patient/"
},
"onsetPeriod": {
"start": "2017-03-06T00:00:00-05:00"
},
"recordedDate": "2018-04-24T00:00:00-04:00",
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"display": "Rash"
}
],
"text": "Rash"
}
],
"severity": "mild"
}
]
}
} ]
}
}
]
}
Appointment
| Method | EndPoint | Description |
| GET | [BaseURL]/Appointment | Returns information about a planned meeting that may be in the future or past. |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
| date | No | Date of Appointment |
| status | No | The status of appointment |
Example:
Request
GET [BaseURL]/Appointment?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "45f804dc-a40b-4343-8588-84bbfe676644",
"meta": {
"lastUpdated": "2023-10-09T10:02:40.324-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Appointment?patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Appointment/10600",
"resource": {
"resourceType": "Appointment",
"id": "10600",
"status": "booked",
"serviceCategory": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/service-category",
"code": "17",
"display": "General Practice"
}
]
}
],
"serviceType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/service-type",
"code": "382",
"display": "Medical Services"
}
]
}
],
"specialty": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394802001",
"display": "General medicine"
}
]
}
],
"appointmentType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0276",
"code": "ROUTINE",
"display": " Routine appointment "
}
],
"text": "New Patient"
},
"start": "2023-10-09T11:30:00.000-04:00",
"end": "2023-10-09T12:00:00.000-04:00",
"minutesDuration": 30,
"created": "2023-01-01T00:00:00-05:00",
"participant": [
{
"actor": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"required": "required",
"status": "accepted"
},
{
"actor": {
"reference": "Practitioner/4",
"display": "Humphries, C T"
},
"required": "required",
"status": "accepted"
},
{
"actor": {
"reference": "Location/561",
"display": "Bradley"
},
"required": "required",
"status": "accepted"
}
]
}
},
{
"fullUrl": "[BaseURL]/Appointment/813366",
"resource": {
"resourceType": "Appointment",
"id": "813366",
"status": "noshow",
"serviceCategory": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/service-category",
"code": "17",
"display": "General Practice"
}
]
}
],
"serviceType": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/service-type",
"code": "382",
"display": "Medical Services"
}
]
}
],
"specialty": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394802001",
"display": "General medicine"
}
]
}
],
"appointmentType": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0276",
"code": "ROUTINE",
"display": " Routine appointment "
}
],
"text": "Annual Physical"
},
"start": "2023-07-03T05:30:00.000-04:00",
"end": "2023-07-03T05:45:00.000-04:00",
"minutesDuration": 15,
"created": "2023-01-01T00:00:00-05:00",
"participant": [
{
"actor": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"required": "required",
"status": "accepted"
},
{
"actor": {
"reference": "Practitioner/3232",
"display": "Ashe, William"
},
"required": "required",
"status": "accepted"
},
{
"actor": {
"reference": "Location/41",
"display": "Charlotte"
},
"required": "required",
"status": "accepted"
}
]
}
}
]
}
Careplan
| Method | EndPoint | Description |
| GET | [BaseURL]/Careplan | Returns patient careplan information for a specific conditon or conditions |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| category | Yes | Fixed value 'assess-plan' |
| status | No | Clinical status |
| date | No | date of encounter greter then,less than or equal |
Example:
Request
GET [BaseURL]/Careplan?patient=[Acct#]&category=assess-plan
Response
200 OK
{
"resourceType": "Bundle",
"id": "13d392e0-c628-439d-93be-d99aa09c8633",
"meta": {
"lastUpdated": "2023-10-05T22:59:57.872+05:30"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/CarePlan?category=assess-plan&patient=100366"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/CarePlan/35036",
"resource": {
"resourceType": "CarePlan",
"id": "35036",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "additional",
"div": "FREQUENCY OF URINATION AND POLYURIA:"
},
"status": "active",
"intent": "plan",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
}
],
"description": "FREQUENCY OF URINATION AND POLYURIA\nAnorexia nervosa, restricting type",
"subject": {
"reference": "Patient/4"
},
"created": "2019-08-23T00:00:00+05:30"
}
}
]
}
CareTeam
| Method | EndPoint | Description |
| GET | [BaseURL]/CareTeam | Returns patient CareTeam information |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| status | No | Clinical status |
| role | No | Role of the participating careteam member like Primary care provider |
Example:
Request
GET [BaseURL]/CareTeam?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "869e4863-6e93-4039-896c-4042e6676cd2",
"meta": {
"lastUpdated": "2023-10-06T17:55:07.847+05:30"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/CareTeam?patient=100366"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/CareTeam/100366",
"resource": {
"resourceType": "CareTeam",
"id": "100366",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"subject": {
"reference": "Patient/100366",
"display": "Jane Andrews"
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "394579002",
"display": "Cardiology"
}
]
}
],
"member": {
"reference": "Practitioner/2669",
"display": "William Ashe"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "453231000124104",
"display": "Primary care provider"
}
]
}
],
"member": {
"reference": "Practitioner/RP-4186",
"display": "Samuel Abrams"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "116154003",
"display": "Patient (person)"
}
]
}
],
"member": {
"reference": "Patient/100366",
"display": "Jane Andrews"
}
}
]
}
}
]
}
ChargeItem
| Method | EndPoint | Description |
| GET | [BaseURL]/ChargeItem | Returns the provision of healthcare provider products for a patient |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
Example:
Request
GET [BaseURL]/ChargeItem?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "9b6a7361-2528-4488-b023-273f086e1283",
"meta": {
"lastUpdated": "2023-10-09T10:42:58.882-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/ChargeItem?patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/ChargeItem/324157",
"resource": {
"resourceType": "ChargeItem",
"id": "324157",
"status": "billable",
"code": {
"coding": [
{
"system": "http://www.ama-assn.org/go/cpt",
"code": "99203"
}
]
},
"subject": {
"reference": "Patient/"
},
"occurrencePeriod": {
"start": "2022-01-14T00:00:00-05:00",
"end": "2022-01-14T00:00:00-05:00"
},
"performer": [
{
"function": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "419772000",
"display": "Family Practice"
}
],
"text": "Family Practice"
},
"actor": {
"reference": "Practitioner/3232",
"display": "Ashe, William"
}
}
],
"performingOrganization": {
"reference": "Organization/"
},
"costCenter": {
"reference": "Organization/"
},
"quantity": {
"value": 1.0
},
"enteredDate": "2022-01-14T00:00:00-05:00",
"reason": [
{
"coding": [
{
"system": "http://hl7.org/fhir/sid/icd-10-cm",
"code": "M54.9",
"display": "Dorsalgia, unspecified"
}
],
"text": "Dorsalgia, unspecified"
}
]
}
}
]
}
Condition
| Method | EndPoint | Description |
| GET | [BaseURL]/Condition | Returns information about a condition or problem |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| clinical-status | No | Clinical status |
| category | No | Condition category |
| code | No | Condition code |
| onset-date | No | Condition onset-date |
Example:
Request
GET [BaseURL]/Condition?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "de2a1969-5ae6-4ce7-9d7a-9e99512313a7",
"meta": {
"lastUpdated": "2023-10-06T18:17:00.742+05:30"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Condition?patient=100366"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Condition/11589",
"resource": {
"resourceType": "Condition",
"id": "11589",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active",
"display": "Active"
}
],
"text": "Active"
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed",
"display": "Confirmed"
}
],
"text": "Confirmed"
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
],
"text": "Encounter Diagnosis"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "91855006",
"display": "ACUTE LEUKEMIA"
}
],
"text": "ACUTE LEUKEMIA"
},
"subject": {
"reference": "Patient/100366"
},
"encounter": {
"reference": "Encounter/35036"
},
"onsetDateTime": "2019-08-23T00:00:00+05:30",
"recordedDate": "2019-08-23T00:00:00+05:30",
"note": [
{
"text": "new"
}
]
}
}
]
}
Coverage
| Method | EndPoint | Description |
| GET | [BaseURL]/Coverage | Returns high-level identifiers and descriptors of an insurance plan that appear on an insurance card |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
Example:
Request
GET [BaseURL]/Coverage?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "7fe50454-c63b-4732-800e-825c6b3ab24a",
"meta": {
"lastUpdated": "2023-10-09T10:36:30.969-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Coverage?patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Coverage/2844",
"resource": {
"resourceType": "Coverage",
"id": "2844",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage"
]
},
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB",
"display": "Member Number"
}
],
"text": "Member Number"
},
"system": "http://example.org/fhir/memberidentifier",
"value": "125464586"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SUBSUPP",
"display": "subsidized supplemental health program"
}
]
},
"subscriberId": "125464586",
"beneficiary": {
"reference": "Patient/"
},
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
"code": "self",
"display": "Self"
}
],
"text": "Self"
},
"period": {
"start": "2010-12-21T00:00:00-05:00"
},
"payor": [
{
"reference": "Organization/PI-2844",
"display": "BCBS"
}
],
"class": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "plan",
"display": "Plan"
}
],
"text": "ValueCare"
},
"value": "125464586",
"name": "ValueCare"
}
]
}
},
{
"fullUrl": "[BaseURL]/Coverage/6659",
"resource": {
"resourceType": "Coverage",
"id": "6659",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage"
]
},
"identifier": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB",
"display": "Member Number"
}
],
"text": "Member Number"
},
"system": "http://example.org/fhir/memberidentifier",
"value": "2346578"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "MCPOL",
"display": "managed care policy"
}
]
},
"subscriberId": "2346578",
"beneficiary": {
"reference": "Patient/"
},
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
"code": "self",
"display": "Self"
}
],
"text": "Self"
},
"period": {
"start": "2014-02-20T00:00:00-05:00"
},
"payor": [
{
"reference": "Organization/PI-6659",
"display": "American Postal Workers"
}
],
"class": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "plan",
"display": "Plan"
}
],
"text": "American Postal Workers"
},
"value": "2346578",
"name": "American Postal Workers"
}
]
}
}
]
}
Device
| Method | EndPoint | Description |
| GET | [BaseURL]/Device | Returns information about all implantable devices for a patient |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| type | No | Type of device(SNOMED code) |
Example:
Request
GET [BaseURL]/Device?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "eef06847-ed82-4d92-8684-d44ef1fdb0f6",
"meta": {
"lastUpdated": "2023-10-06T19:55:37.264+05:30"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Device?patient=100366"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Device/201",
"resource": {
"resourceType": "Device",
"id": "201",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "99863313444316",
"carrierHRF": "(01)99863313444316(17)220101(10)M320(21)AC2212",
"entryType": "rfid"
}
],
"status": "active",
"distinctIdentifier": "99863313444316",
"expirationDate": "2022-01-01T00:00:00+05:30",
"lotNumber": "M320",
"serialNumber": "AC2212",
"patient": {
"reference": "Patient/100366"
}
}
}
]
}
Diagnostic Report
| Method | EndPoint | Description |
| GET | [BaseURL]/DiagnosticReport | Returns information about patient Diagnostic reports |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| category | No | diagnostic discipline or department |
| date | No | Date of the report |
| status | No | The status of the report |
Example:
Request
GET [BaseURL]/DiagnosticReport?category=LAB&patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "a7b7eb0b-efc6-4d8f-b7ce-c64d8a4a15f6",
"meta": {
"lastUpdated": "2023-10-06T11:38:28.161-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/DiagnosticReport?category=LAB&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/DiagnosticReport/PLRO-6467",
"resource": {
"resourceType": "DiagnosticReport",
"id": "PLRO-6467",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "LAB",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "58410-2",
"display": "CBC panel - Blood by Automated count"
}
]
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"encounter": {
"reference": "Encounter/55915"
},
"effectiveDateTime": "2022-10-12T00:00:00-04:00",
"issued": "2022-10-12T00:00:00.000-04:00",
"performer": [
{
"reference": "Practitioner/4"
},
{
"reference": "Organization/1"
}
],
"result": [
{
"reference": "Observation/PLROD-27556",
"display": "Neutrophils %"
},
{
"reference": "Observation/PLROD-27557",
"display": "MCHC RBC Auto-mCnc"
},
{
"reference": "Observation/PLROD-27558",
"display": "Hgb Bld-mCnc"
},
{
"reference": "Observation/PLROD-27559",
"display": "RBC # Bld Auto"
}
],
"media": [
{
"link": {
"reference": "Media/PLRO-6467",
"display": "CBC panel - Blood by Automated count"
}
}
],
"presentedForm": [
{
"contentType": "application/pdf",
"url": "[BaseURL]/docs/api/labresults/4153.pdf"
}
]
}
}
]
}
Document Reference
| Method | EndPoint | Description |
| GET | [BaseURL]/DocumentReference | Returns references to patient documents like clinical note |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| category | No | Categorization of document |
| date | No | Date of the document reference creation |
| status | No | Document reference status like current or superseded or entered-in-error |
| type | No | Type of document (LOINC if possible) |
Example:
Request
GET [BaseURL]/DocumentReference?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "14cbe6f6-e0f0-4bc8-b258-c83f7546a893",
"meta": {
"lastUpdated": "2023-10-06T11:38:31.696-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/DocumentReference?companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/DocumentReference/PE-30320",
"resource": {
"resourceType": "DocumentReference",
"id": "PE-30320",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical Note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"date": "2013-07-21T00:00:00.000-04:00",
"author": [
{
"reference": "Practitioner/4"
}
],
"custodian": {
"reference": "Organization/1"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "[BaseURL]/docs/api/encounters/30320.pdf"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/30320"
}
]
}
}
},
{
"fullUrl": "[BaseURL]/DocumentReference/PE-45795",
"resource": {
"resourceType": "DocumentReference",
"id": "PE-45795",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical Note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"date": "2020-04-27T00:00:00.000-04:00",
"author": [
{
"reference": "Practitioner/4"
}
],
"custodian": {
"reference": "Organization/1"
},
"content": [
{
"attachment": {
"contentType": "application/pdf",
"url": "[BaseURL]/docs/api/encounters/45795.pdf"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/45795"
}
]
}
}
}
}
Encounter
| Method | EndPoint | Description |
| GET | [BaseURL]/Encounter | Returns information about patient a encounter or all encounters |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| _id | No | Particular Encounter ID |
| date | No | Date of Encounter |
Example:
Request
GET [BaseURL]/Encounter?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "93676221-1e12-4768-8499-9c022e835548",
"meta": {
"lastUpdated": "2023-10-06T20:26:23.951+05:30"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Encounter?patient=100366"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Encounter/35036",
"resource": {
"resourceType": "Encounter",
"id": "35036",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"identifier": [
{
"value": "35036"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB",
"display": "Ambulatory"
},
"subject": {
"reference": "Patient/100366"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"period": {
"start": "2019-08-23T00:00:00+05:30",
"end": "2019-08-23T00:00:00+05:30"
},
"individual": {
"reference": "Practitioner/2669",
"display": "Ashe, William [MD]"
}
},
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "REF",
"display": "referrer"
}
],
"text": "referrer"
}
],
"period": {
"start": "2019-08-23T00:00:00+05:30",
"end": "2019-08-23T00:00:00+05:30"
},
"individual": {
"reference": "Practitioner/RP-4186",
"display": "Abrams, Samuel [MD]"
}
}
],
"period": {
"start": "2019-08-23T00:00:00+05:30",
"end": "2019-08-23T00:00:00+05:30"
},
"diagnosis": [
{
"condition": {
"reference": "Condition/11589",
"display": "ACUTE LEUKEMIA"
}
}
],
"location": [
{
"location": {
"reference": "Location/26",
"display": "Rock Hill"
}
}
],
"serviceProvider": {
"reference": "Organization/1"
}
}
},
{
"fullUrl": "[BaseURL]/Encounter/40539",
"resource": {
"resourceType": "Encounter",
"id": "40539",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"identifier": [
{
"value": "40539"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB",
"display": "Ambulatory"
},
"subject": {
"reference": "Patient/100336"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"period": {
"start": "2023-06-21T00:00:00+05:30",
"end": "2023-06-21T00:00:00+05:30"
},
"individual": {
"reference": "Practitioner/2669",
"display": "Ashe, William [MD]"
}
}
],
"period": {
"start": "2023-06-21T00:00:00+05:30",
"end": "2023-06-21T00:00:00+05:30"
},
"location": [
{
"location": {
"reference": "Location/26",
"display": "Rock Hill"
}
}
],
"serviceProvider": {
"reference": "Organization/1"
}
}
}
]
}
Family Member History
| Method | EndPoint | Description |
| GET | [BaseURL]/FamilyMemberHistory | Returns the health conditions for a particular individual related to the patient |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
Example:
Request
GET [BaseURL]/FamilyMemberHistory?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "cb50e6be-baf8-48ca-87b9-e597499ae305",
"meta": {
"lastUpdated": "2023-10-09T11:00:18.036-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/FamilyMemberHistory?patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/FamilyMemberHistory/19813",
"resource": {
"resourceType": "FamilyMemberHistory",
"id": "19813",
"status": "completed",
"patient": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"date": "2020-04-29T00:00:00-04:00",
"relationship": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "66839005",
"display": "Father"
}
],
"text": "Father"
},
"deceasedBoolean": false,
"condition": [
{
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "233159005",
"display": "Arrhythmia"
}
]
}
}
]
}
},
{
"fullUrl": "[BaseURL]/FamilyMemberHistory/19814",
"resource": {
"resourceType": "FamilyMemberHistory",
"id": "19814",
"status": "completed",
"patient": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"date": "2020-04-29T00:00:00-04:00",
"relationship": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72705000",
"display": "Mother"
}
],
"text": "Mother"
},
"deceasedBoolean": false,
"condition": [
{
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "233159005",
"display": "Arrhythmia"
}
]
}
}
]
}
}
]
}
Goal
| Method | EndPoint | Description |
| GET | [BaseURL]/Goal | Returns information about patient Goals to be achieved by subject of care |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| lifecycle-status | No | Goal lifecycle like active,planned etc |
| target-date | No | Reach goal on or before this date |
Example:
Request
GET [BaseURL]/Goal?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "f6146eca-40e7-4642-bc37-500e0d377a98",
"meta": {
"lastUpdated": "2023-10-06T11:38:31.823-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Goal?companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Goal/61",
"resource": {
"resourceType": "Goal",
"id": "61",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
]
},
"lifecycleStatus": "active",
"achievementStatus": {
"coding": [
{
"code": "in-progress",
"display": "In Progress"
}
]
},
"description": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "406156006",
"display": "In paid employment"
}
],
"text": "In paid employment"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"target": [
{
"dueDate": "2022-12-31"
}
],
"statusDate": "2022-10-03"
}
}
]
}
Immunization
| Method | EndPoint | Description |
| GET | [BaseURL]/Immunization | Returns record of patient immunizations |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
Example:
Request
GET [BaseURL]/Immunization?patient=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "08c37a86-1556-49f9-aa1c-3751dcdf1935",
"meta": {
"lastUpdated": "2023-10-06T11:38:31.927-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Immunization?companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Immunization/10028",
"resource": {
"resourceType": "Immunization",
"id": "10028",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "entered-in-error",
"statusReason": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/ActReason",
"code": "PATOBJ"
}
],
"text": "Patient decision"
},
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "141",
"display": "Influenza Vaccination"
}
]
},
"patient": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"occurrenceDateTime": "2022-09-02T00:00:00-04:00",
"primarySource": true,
"manufacturer": {
"reference": "Manufacturer/GlaxoSmithKline",
"display": "Organization/hl7"
},
"lotNumber": "12345",
"expirationDate": "2023-10-01",
"site": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/ActSite",
"code": "Left Arm"
}
]
},
"route": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/RouteOfAdministration",
"code": "Apply Externally"
}
]
},
"doseQuantity": {
"value": 1
},
"performer": [
{
"actor": {
"reference": "4",
"display": "primary performer"
}
}
]
}
}
]
}
Medication Request
| Method | EndPoint | Description |
| GET | [BaseURL]/MedicationRequest | Returns all types of medication orders for a patient |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| intent | No | Medication request intent(order or proposal or order or plan) |
| status | No | Status of the Request |
Example:
Request
GET [BaseURL]/MedicationRequest?intent=proposal&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "e3204f0a-6ae6-49f0-9a2a-fca497795149",
"meta": {
"lastUpdated": "2023-10-06T11:38:32.025-04:00"
},
"type": "searchset",
"total": 0,
"link": [
{
"relation": "self",
"url": "[BaseURL]/MedicationRequest?companyID=1&intent=proposal&patient=100126"
}
]
}
Request
GET [BaseURL]/MedicationRequest?intent=order&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "fd3b50ab-2491-4abd-978c-421a8cb74bd7",
"meta": {
"lastUpdated": "2023-10-07T07:09:32.107-04:00"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "[BaseURL]/MedicationRequest?intent=order&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/MedicationRequest/30967",
"resource": {
"resourceType": "MedicationRequest",
"id": "30967",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
"code": "outpatient",
"display": "Outpatient"
}
],
"text": "Outpatient"
}
],
"reportedBoolean": false,
"medicationReference": {
"reference": "Medication/1864"
},
"subject": {
"reference": "Patient/100126"
},
"authoredOn": "2020-03-20T00:00:00-04:00",
"requester": {
"reference": "Practitioner/3237"
},
"dosageInstruction": [
{
"text": "1st week test on arm. Then q 3 days to face x 2 then q 2 days x 2 then daily. 1/2 hour after wash and dry off face."
}
],
"dispenseRequest": {
"numberOfRepeatsAllowed": 1,
"quantity": {
"value": 15.0
},
"expectedSupplyDuration": {
"value": 1.0,
"unit": "days",
"system": "http://unitsofmeasure.org",
"code": "d"
}
},
"substitution": {
"allowedBoolean": true
}
}
},
{
"fullUrl": "[BaseURL]/MedicationRequest/31165",
"resource": {
"resourceType": "MedicationRequest",
"id": "31165",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
"code": "outpatient",
"display": "Outpatient"
}
],
"text": "Outpatient"
}
],
"reportedBoolean": false,
"medicationReference": {
"reference": "Medication/1864"
},
"subject": {
"reference": "Patient/100126"
},
"authoredOn": "2020-03-20T00:00:00-04:00",
"requester": {
"reference": "Practitioner/3237"
},
"dosageInstruction": [
{
"text": "1st week test on arm. Then q 3 days to face x 2 then q 2 days x 2 then daily. 1/2 hour after wash and dry off face."
}
],
"dispenseRequest": {
"numberOfRepeatsAllowed": 1,
"quantity": {
"value": 15.0
},
"expectedSupplyDuration": {
"value": 1.0,
"unit": "days",
"system": "http://unitsofmeasure.org",
"code": "d"
}
},
"substitution": {
"allowedBoolean": true
}
}
},
{
"fullUrl": "[BaseURL]/MedicationRequest/32345",
"resource": {
"resourceType": "MedicationRequest",
"id": "32345",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/medicationrequest-category",
"code": "outpatient",
"display": "Outpatient"
}
],
"text": "Outpatient"
}
],
"reportedBoolean": false,
"medicationReference": {
"reference": "Medication/1864"
},
"subject": {
"reference": "Patient/100126"
},
"authoredOn": "2020-03-20T00:00:00-04:00",
"requester": {
"reference": "Practitioner/3237"
},
"dosageInstruction": [
{
"text": "1st week test on arm. Then q 3 days to face x 2 then q 2 days x 2 then daily. 1/2 hour after wash and dry off face."
}
],
"dispenseRequest": {
"numberOfRepeatsAllowed": 1,
"quantity": {
"value": 15.0
},
"expectedSupplyDuration": {
"value": 1.0,
"unit": "days",
"system": "http://unitsofmeasure.org",
"code": "d"
}
},
"substitution": {
"allowedBoolean": true
}
}
}
]
}
Observation
| Method | EndPoint | Description |
| GET | [BaseURL]/Observation | Returns Observation data like Vitals,Laboratory Data,Imaging results,Social history etc |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
| date | No | Date of Observation |
| category | No | The classification of the type of observation |
| code | Yes | The code of the observation type |
| status | No | The status of the observation |
Example:
Request Laboratory
GET [BaseURL]/Observation?category=laboratory&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "0a63a655-ddf5-4614-8bf7-f3fcdbc20ef2",
"meta": {
"lastUpdated": "2023-10-07T09:18:24.813-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?category=laboratory&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PLROD-27556",
"resource": {
"resourceType": "Observation",
"id": "PLROD-27556",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "770-8",
"display": "Neutrophils %"
}
],
"text": "Neutrophils %"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"encounter": {
"reference": "Encounter/55915"
},
"effectiveDateTime": "2022-10-12T00:00:00-04:00",
"valueString": "40.0%",
"referenceRange": [
{
"low": {
"value": 37,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
},
"high": {
"value": 67,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
},
"text": "37.0% - 67.0%"
}
]
}
}
]
}
}
]
}
Request Respiratory Rate
GET [BaseURL]/Observation?category=vital-signs&code=9279-1&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "cf251668-9419-4f82-b70d-197eab89632b",
"meta": {
"lastUpdated": "2023-10-07T09:18:34.227-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=9279-1&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-RR-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-RR-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:34.226-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-respiratory-rate"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "9279-1",
"display": "Respiratory rate"
}
],
"text": "Respiratory rate"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 18,
"unit": "beats/minute",
"system": "http://unitsofmeasure.org",
"code": "/min"
}
}
}
]
}
Request Heart Rate
GET [BaseURL]/Observation?category=vital-signs&code=8867-4&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "d8847f45-6aed-409c-a4d8-fcf26c5a04cb",
"meta": {
"lastUpdated": "2023-10-07T09:18:39.877-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://[BaseURL]/Observation?code=8867-4&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-HR-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-HR-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:39.877-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-heart-rate"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8867-4",
"display": "Heart rate"
}
],
"text": "Heart rate"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 72,
"unit": "beats/minute",
"system": "http://unitsofmeasure.org",
"code": "/min"
}
}
}
]
}
Request Body Temperature
GET [BaseURL]/Observation?category=vital-signs&code=8310-5&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "ad97ea71-be69-4771-a70a-bfb9383b6f5e",
"meta": {
"lastUpdated": "2023-10-07T09:18:42.833-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=8310-5&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-TMP-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-TMP-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:42.833-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-temperature"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 37,
"unit": "C",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
}
}
]
}
Request Pulse Oximetry
GET [BaseURL]/Observation?category=vital-signs&code=59408-5&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "4124ddaf-00fe-40eb-97e3-e37a4e1ad120",
"meta": {
"lastUpdated": "2023-10-07T09:18:48.392-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=59408-5&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-OS-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-OS-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:48.390-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59408-5",
"display": "Oxygen saturation in Arterial blood by Pulse oximetry"
},
{
"system": "http://loinc.org",
"code": "2708-6",
"display": "Oxygen saturation in Arterial blood"
}
]
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 85,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
},
"component": [
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "3151-8",
"display": "Inhaled oxygen flow rate"
}
],
"text": "Oxygen Flow Rate"
},
"valueQuantity": {
"value": 7,
"unit": "liters/min",
"system": "http://unitsofmeasure.org",
"code": "L/min"
}
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "3150-0",
"display": "Inhaled Oxygen concentration"
}
],
"text": "Inhaled Oxygen concentration"
},
"valueQuantity": {
"value": 45,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
}
}
]
}
}
]
}
Request Body Height
GET [BaseURL]/Observation?category=vital-signs&code=8302-2&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "1dada04f-4aa7-4bd3-b179-094e50d1b07d",
"meta": {
"lastUpdated": "2023-10-07T09:18:56.797-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=8302-2&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-HT-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-HT-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:56.797-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-height"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8302-2",
"display": "Body height"
}
],
"text": "Body height"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 170,
"unit": "cm",
"system": "http://unitsofmeasure.org",
"code": "cm"
}
}
}
]
}
Request BMI
GET [BaseURL]/Observation?category=vital-signs&code=39156-5&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "d4684d8a-f7e4-4a79-a6e8-422b3a329567",
"meta": {
"lastUpdated": "2023-10-07T09:18:59.051-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=39156-5&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-BMI-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-BMI-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:59.051-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-bmi"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "39156-5",
"display": "Body mass index (BMI) [Ratio]"
}
],
"text": "Body mass index (BMI) [Ratio]"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 24.2,
"unit": "kg/m2",
"system": "http://unitsofmeasure.org",
"code": "kg/m2"
}
}
}
]
}
Request Blood Pressure
GET [BaseURL]/Observation?category=vital-signs&code=85354-9&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "c61471a4-d875-4627-91fa-106144dcfa13",
"meta": {
"lastUpdated": "2023-10-07T09:19:01.296-04:00"
},
"type": "searchset",
"total": 3,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=85354-9&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-BP-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-BP-18309",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-blood-pressure"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "85354-9",
"display": "Bood pressure panel with all children optional"
}
]
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"component": [
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8480-6",
"display": "Systolic blood pressure"
}
]
},
"valueQuantity": {
"value": 130,
"unit": "mmHg",
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
},
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8462-4",
"display": "Diastolic blood pressure"
}
]
},
"valueQuantity": {
"value": 100,
"unit": "mmHg",
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
}
]
}
}
]
}
Request Body Weight
GET [BaseURL]/Observation?category=vital-signs&code=29463-7&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "e817389e-cf8e-4111-8e70-f753a70cb6e4",
"meta": {
"lastUpdated": "2023-10-07T09:19:49.475-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=29463-7&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-WT-18309",
"resource": {
"resourceType": "Observation",
"id": "PVT-WT-18309",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:19:49.429-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-body-weight"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "29463-7",
"display": "Body weight"
}
],
"text": "Body weight"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2020-07-16T00:00:00-04:00",
"valueQuantity": {
"value": 70,
"unit": "kg",
"system": "http://unitsofmeasure.org",
"code": "kg"
}
}
}
]
}
Request Smoking Status
GET [BaseURL]/Observation?category=vital-signs&code=72166-2&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "0628eb46-d56a-4d60-a00e-c66c619b08f9",
"meta": {
"lastUpdated": "2023-10-07T09:18:51.244-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=72166-2&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PSS-45795",
"resource": {
"resourceType": "Observation",
"id": "PSS-45795",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "social-history",
"display": "Social History"
}
],
"text": "Social History"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status"
}
],
"text": "Tobacco smoking status"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"encounter": {
"reference": "Encounter/45795"
},
"effectiveDateTime": "2020-04-27T00:00:00-04:00",
"performer": [
{
"reference": "Practitioner/4"
}
],
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "449868002",
"display": "current every day smoker"
}
],
"text": "current every day smoker"
}
}
}
]
}
Request Social History
GET [BaseURL]/Observation?category=social-history&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "74285b42-f83f-4203-aa1b-92e500b33881",
"meta": {
"lastUpdated": "2023-10-07T09:18:37.056-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?category=social-history&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PSH-SStu-45795",
"resource": {
"resourceType": "Observation",
"id": "PSH-SStu-45795",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-social-history"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-tags",
"code": "sdoh",
"display": "SDOH"
}
],
"text": "SDOH"
},
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "social-history",
"display": "Social History"
}
],
"text": "Social History"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status"
}
],
"text": "Tobacco smoking status"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"encounter": {
"reference": "Encounter/45795"
},
"effectiveDateTime": "2020-04-27T00:00:00-04:00",
"performer": [
{
"reference": "Practitioner/4"
}
],
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "449868002",
"display": "current every day smoker"
}
],
"text": "current every day smoker"
}
}
}
]
}
Request Clinical Test Result
GET [BaseURL]/Observation?code=44973-6&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "a7f6b4bd-c27d-4cf7-993e-3ca963b98f33",
"meta": {
"lastUpdated": "2023-10-07T09:19:25.847-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=44973-6&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PLROD-27527",
"resource": {
"resourceType": "Observation",
"id": "PLROD-27527",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-clinical-test"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-observation-category",
"code": "clinical-test",
"display": "Clinical Test"
}
],
"text": "Clinical Test"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "44973-6",
"display": "QRS dur {EKG lead}"
}
],
"text": "QRS dur {EKG lead}"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"encounter": {
"reference": "Encounter/55915"
},
"effectiveDateTime": "2022-10-12T00:00:00-04:00",
"valueQuantity": {
"value": 60,
"unit": "ms",
"system": "http://unitsofmeasure.org",
"code": "ms"
}
}
}
]
}
Request Sexual Orientation
GET [BaseURL]/Observation?code=76690-7&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "eb11cf3c-d105-4421-849a-808c98ad8af3",
"meta": {
"lastUpdated": "2023-10-07T09:18:53.721-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=76690-7&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PSO-100126",
"resource": {
"resourceType": "Observation",
"id": "PSO-100126",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-sexual-orientation"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "social-history",
"display": "Social History"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "76690-7",
"display": "Choose not to disclose"
}
],
"text": "Sexual orientation"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"effectiveDateTime": "2022-11-02T00:00:00-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-NullFlavor",
"code": "ASKU",
"display": "Choose not to disclose"
}
],
"text": "Choose not to disclose"
}
}
}
]
}
Request Pediatric Weight for Height
GET [BaseURL]/Observation?code=77606-2&patient=2311
Response
200 OK
{
"resourceType": "Bundle",
"id": "f840fab6-de1a-4eed-922d-7a216f58ed73",
"meta": {
"lastUpdated": "2023-10-07T09:18:45.408-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=77606-2&companyID=1&patient=2311"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-PWTHT-20274",
"resource": {
"resourceType": "Observation",
"id": "PVT-PWTHT-20274",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:45.408-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "77606-2",
"display": "Weight-for-length Per age and sex"
}
],
"text": "Weight-for-length Per age and sex"
},
"subject": {
"reference": "Patient/2311",
"display": "Pediatric Doe"
},
"encounter": {
"reference": "Encounter/48834"
},
"effectiveDateTime": "2022-10-21T00:00:00-04:00",
"valueQuantity": {
"value": 50,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
},
"note": [
{
"text": "WHO Females, 0-2 years Chart"
}
]
}
}
]
}
Request Head Circumference
GET [BaseURL]/Observation?code=9843-4&patient=2311
Response
200 OK
{
"resourceType": "Bundle",
"id": "a676aa6c-e0ec-47a1-9941-f8d91add206b",
"meta": {
"lastUpdated": "2023-10-07T09:18:54.945-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=9843-4&companyID=1&patient=2311"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-HC-48834",
"resource": {
"resourceType": "Observation",
"id": "PVT-HC-48834",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:18:54.945-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-head-circumference"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "9843-4",
"display": "Head Occipital-frontal circumference"
}
],
"text": "Head Circumference"
},
"subject": {
"reference": "Patient/2311",
"display": "Pediatric Doe"
},
"effectiveDateTime": "2022-10-17T00:00:00-04:00",
"valueQuantity": {
"value": 13.5,
"unit": "in",
"system": "http://unitsofmeasure.org",
"code": "[in_i]"
}
}
}
]
}
Request Pediatric BMI
GET [BaseURL]/Observation?code=59576-9&patient=2311
Response
200 OK
{
"resourceType": "Bundle",
"id": "b69d5220-30d4-438d-b673-49ca9f075cc9",
"meta": {
"lastUpdated": "2023-10-07T09:19:39.034-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=59576-9&companyID=1&patient=2311"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-PBMI-20274",
"resource": {
"resourceType": "Observation",
"id": "PVT-PBMI-20274",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:19:39.034-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59576-9",
"display": "Body mass index (BMI) [Percentile] Per age and gender"
}
],
"text": "Body mass index (BMI) [Percentile] Per age and gender"
},
"subject": {
"reference": "Patient/2311",
"display": "Pediatric Doe"
},
"encounter": {
"reference": "Encounter/48834"
},
"effectiveDateTime": "2022-10-21T00:00:00-04:00",
"valueQuantity": {
"value": 55,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
},
"note": [
{
"text": "CDC Females, 2-20 years Chart"
}
]
}
}
]
}
Request Pediatric Head Occipital-frontal Circumference Percentile
GET [BaseURL]/Observation?code=8289-1&patient=2311
Response
200 OK
{
"resourceType": "Bundle",
"id": "73215f3e-39b6-4187-858e-2cb520b27d3d",
"meta": {
"lastUpdated": "2023-10-07T09:19:47.072-04:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=8289-1&companyID=1&patient=2311"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PVT-OFC-48834",
"resource": {
"resourceType": "Observation",
"id": "PVT-OFC-48834",
"meta": {
"versionId": "1",
"lastUpdated": "2023-10-07T09:19:47.072-04:00",
"source": "lkJgEM/rZ10ygJdJHOZE7w==",
"profile": [
"http://hl7.org/fhir/StructureDefinition/vitalsigns",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
],
"text": "Vital Signs"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8289-1",
"display": "Head Occipital-frontal circumference Percentile"
}
],
"text": "Head Occipital-frontal circumference Percentile"
},
"subject": {
"reference": "Patient/2311",
"display": "Pediatric Doe"
},
"encounter": {
"reference": "Encounter/48834"
},
"effectiveDateTime": "2022-10-21T00:00:00-04:00",
"valueQuantity": {
"value": 17,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
},
"note": [
{
"text": "WHO Females, 0-3 years Chart"
}
]
}
}
]
}
Request Imaging Results
GET [BaseURL]/Observation?code=36554-4&patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "4a580cdf-ef4e-470b-bbd7-577668f789bf",
"meta": {
"lastUpdated": "2023-10-07T09:19:06.692-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Observation?code=36554-4&companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Observation/PLI-481",
"resource": {
"resourceType": "Observation",
"id": "PLI-481",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-imaging"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "imaging",
"display": "Imaging"
}
],
"text": "Imaging"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "36554-4",
"display": "Chest X-ray"
}
],
"text": "Chest X-ray"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"encounter": {
"reference": "Encounter/30320"
},
"effectiveDateTime": "2015-03-10T00:00:00-04:00",
"valueString": "LINES AND TUBES: None. LUNGS AND PLEURA: Clear lungs. Normal pulmonary vascularity. No pleural effusion. No pneumothorax. HEART, MEDIASTINUM AND HILA: Heart is normal in size. Normal mediastinal and hilar contour. BONES AND SOFT TISSUES: No acute abnormality."
}
}
]
}
Organization
| Method | EndPoint | Description |
| GET | [BaseURL]/Organization | Returns the details of Organization to be used as a reference from other resources |
| Parameter | Mandatory | Description |
| _id | Yes | Organization identifier |
| name | No | Name of the Organization |
Example:
Request
GET [BaseURL]/Organization/1
Response
200 OK
{
"resourceType": "Organization",
"id": "1",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"identifier": [
{
"system": "[BaseURL]",
"value": "1"
},
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "1298765654"
}
],
"active": true,
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/organization-type",
"code": "prov",
"display": "Healthcare Provider"
}
]
}
],
"name": "Agastha Medical Center",
"telecom": [
{
"system": "phone",
"value": "(980)375-2751"
},
{
"system": "fax",
"value": "(704)910-2372"
}
],
"address": [
{
"line": [
"15720 John J. Delaney Drive",
"Suite 204"
],
"city": "Charlotte",
"state": "TN",
"postalCode": "28277",
"country": "US"
}
]
}
Patient
| Method | EndPoint | Description |
| GET | [BaseURL]/Patient | Returns patient demographics information |
| Parameter | Mandatory | Description |
| _id | Yes | Patient Acct# |
| name | No | Patient last name/first name |
| gender | No | Male/Female |
| birthdate | No | Patient birthdate |
| given | No | Patient first name/Middle Initial |
| family | No | Patient last name |
| prefix | No | Patient title |
| suffix | No | Patient suffix |
Example:
Request
GET [BaseURL]/Patient?_id=[Acct#]
Response
200 OK
{
"resourceType": "Bundle",
"id": "41b44f0f-8fd7-4ede-8d76-a6e496326038",
"meta": {
"lastUpdated": "2023-10-05T06:54:10.990-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Patient?_id=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Patient/100126",
"resource": {
"resourceType": "Patient",
"id": "100126",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text": {
"status": "generated",
"div": "Mrs Mary M PALTROW II Identifier 100126 Address 2645 Mulberry Lane
new lane
Toledo OH US Date of birth 18 June 1950
"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "F"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Not Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Not Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-genderIdentity",
"valueCodeableConcept": {
"coding": [
{
"code": "446141000124107",
"display": "Female"
}
],
"text": "Female"
}
}
],
"identifier": [
{
"system": "[BaseURL]",
"value": "100126"
},
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
],
"text": "Medical Record Number"
},
"system": "https://demo1.agastha.com/demo1/AgAPI",
"value": "100126"
}
],
"active": true,
"name": [
{
"use": "official",
"family": "Paltrow",
"given": [
"Mary",
"M"
],
"prefix": [
"Mrs"
],
"suffix": [
"II"
]
},
{
"use": "old",
"family": "Paltrow",
"given": [
"Marysam"
],
"period": {
"start": "2022-10-08T11:55:00-04:00",
"end": "2022-10-08T11:55:00-04:00"
}
},
{
"use": "old",
"family": "Paltrow",
"given": [
"Marycom"
],
"period": {
"start": "2022-10-08T11:55:00-04:00"
}
}
],
"telecom": [
{
"system": "phone",
"value": "(419)855-3055",
"use": "home"
},
{
"system": "other",
"value": "(704)363-9619",
"use": "home"
},
{
"system": "other",
"value": "(772)266-5589",
"use": "home"
},
{
"system": "sms",
"value": "(994)037-7468",
"use": "home"
},
{
"system": "pager",
"value": "(513)393-2136",
"use": "home"
},
{
"system": "fax",
"value": "(984)071-1771",
"use": "home"
},
{
"system": "email",
"value": "support@agastha.com",
"use": "home"
}
],
"gender": "female",
"birthDate": "1950-06-18",
"address": [
{
"use": "home",
"line": [
"2645 Mulberry Lane",
"new lane"
],
"city": "Toledo",
"state": "OH",
"postalCode": "43605",
"country": "US"
},
{
"use": "old",
"line": [
"2645 Mulberry Lane",
"new lane"
],
"city": "Toledo",
"state": "OH",
"postalCode": "43605",
"country": "US",
"period": {
"start": "2009-02-18T05:42:00-05:00"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "L",
"display": "Legally Separated"
}
],
"text": "Legally Separated"
},
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en",
"display": "English"
}
],
"text": "English"
}
}
],
"generalPractitioner": [
{
"reference": "Practitioner/4"
}
]
}
}
]
}
Procedure
| Method | EndPoint | Description |
| GET | [BaseURL]/Procedure | Returns the details of current and historical procedures performed for a patient |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Acct# |
| date | No | Date of the procedure |
| code | No | A code to identify procedure |
Example:
Request
GET [BaseURL]/Procedure?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "05335e34-259f-4b4b-a0b7-8fd1346d4571",
"meta": {
"lastUpdated": "2023-10-06T11:38:32.252-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/Procedure?companyID=1&patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/Procedure/14301",
"resource": {
"resourceType": "Procedure",
"id": "14301",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "119954001",
"display": "Adenoidectomy"
}
],
"text": "Adenoidectomy"
},
"subject": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"performedDateTime": "2019-09-07T00:00:00-04:00"
}
}
]
}
Provenance
| Method | EndPoint | Description |
| GET | [BaseURL]/Provance | Returns the clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
Example:
Request
GET [BaseURL]/Provance/100126
Response
200 OK
{
"resourceType": "Provenance",
"id": "100126",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
]
},
"target": [
{
"reference": "Appointment/10600"
},
{
"reference": "Organization/1"
},
{
"reference": "CareTeam/100126"
},
{
"reference": "DiagnosticReport/PLRO-6464"
},
{
"reference": "AllergyIntolerance/11605"
},
{
"reference": "CarePlan/30320"
},
{
"reference": "Goal/61"
},
{
"reference": "FamilyMemberHistory/19813"
},
{
"reference": "Consent/1961"
},
{
"reference": "Medication/1864"
},
{
"reference": "Encounter/41065"
},
{
"reference": "DocumentReference/P-100126"
},
{
"reference": "Condition/8137"
},
{
"reference": "MedicationRequest/38539"
},
{
"reference": "Device/181"
},
{
"reference": "RelatedPerson/100126"
},
{
"reference": "Practitioner/3729"
},
{
"reference": "Observation/PLROD-27535"
},
{
"reference": "Location/41"
}
],
"recorded": "2009-02-18T00:00:00.000-05:00",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author",
"display": "Author"
}
],
"text": "Author"
},
"who": {
"reference": "Organization/1",
"display": "Agastha Medical Center"
},
"onBehalfOf": {
"reference": "Organization/1",
"display": "Agastha Medical Center"
}
},
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
"code": "transmitter",
"display": "Transmitter"
}
],
"text": "Transmitter"
},
"who": {
"reference": "Organization/1",
"display": "Agastha Medical Center"
},
"onBehalfOf": {
"reference": "Organization/1",
"display": "Agastha Medical Center"
}
}
]
}
Practitioner
| Method | EndPoint | Description |
| GET | [BaseURL]/Practitioner | Returns the details of a person who is directly or indirectly involved in the provisioning of healthcare. |
| Parameter | Mandatory | Description |
| identifier | Yes | Practitioner identifier |
| name | No | Name of the Practitioner |
Example:
Request
GET [BaseURL]/Practitioner/4
Response
200 OK
{
"resourceType": "Practitioner",
"id": "4",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "1245319599"
}
],
"active": true,
"name": [
{
"family": "Humphries",
"given": [
"J"
],
"prefix": [
"Dr"
]
}
],
"telecom": [
{
"system": "phone",
"value": "(513)668-4215",
"use": "work"
},
{
"system": "other",
"value": "(704)363-9619",
"use": "work"
},
{
"system": "sms",
"value": "(704)363-9619",
"use": "work"
},
{
"system": "email",
"value": "rabort@practice.com",
"use": "work"
}
],
"address": [
{
"use": "work",
"line": [
"24 Piper Station",
"Suite 104"
],
"city": "Charlotte",
"state": "NC",
"postalCode": "28277",
"country": "US"
}
]
}
RelatedPerson
| Method | EndPoint | Description |
| GET | [BaseURL]/RelatedPerson | Returns a personal or non-healthcare-specific professional relationship to the patient. |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
| identifier | No | An Identifier of the RelatedPerson |
Example:
Request
GET [BaseURL]/RelatedPerson?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "aa2ee84d-a0ec-4cd7-9e9e-2ce65e5c8bc1",
"meta": {
"lastUpdated": "2023-10-07T13:13:51.924-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "[BaseURL]/RelatedPerson?patient=100126"
}
],
"entry": [
{
"fullUrl": "[BaseURL]/RelatedPerson/100126",
"resource": {
"resourceType": "RelatedPerson",
"id": "100126",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson"
]
},
"active": true,
"patient": {
"reference": "Patient/100126",
"display": "Mary Paltrow"
},
"relationship": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
"code": "Niece",
"display": "Niece"
}
]
}
],
"name": [
{
"use": "official",
"family": "Niece",
"given": [
"Shaw"
]
}
],
"telecom": [
{
"system": "phone",
"value": "(704)636-9616",
"use": "home"
},
{
"system": "email",
"value": "shawniece@agastha.com",
"use": "home"
}
],
"address": [
{
"use": "home",
"line": [
"123 pine st"
],
"city": "Vandiver",
"postalCode": "35147",
"country": "US"
}
]
}
}
]
}
ServiceRequest
| Method | EndPoint | Description |
| GET | [BaseURL]/ServiceRequest | Returns a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed |
| Parameter | Mandatory | Description |
| patient | Yes | Patient Identifier |
| identifier | No | An Identifier of the ServiceRequest |
| category | No | Classification of service |
| code | No | What is being requested/ordered |
| status | No | Service requset status like draft or active or on-hold or revoked or completed |
Example:
Request
GET [BaseURL]/ServiceRequest?patient=100126
Response
200 OK
{
"resourceType": "Bundle",
"id": "9687d09d-8cdf-4654-9214-41cdf8a7633f",
"meta": {
"lastUpdated": "2023-10-06T11:38:32.587-04:00"
},
"type": "searchset",
"total": 0,
"link": [
{
"relation": "self",
"url": "[BaseURL]/ServiceRequest?companyID=1&patient=100126"
}
]
}
Copyright © Agastha, Inc. all rights reserved!