API Documentation
Introduction

Curl Request

Introduction


        

CharmHealth EHR V1.2 API program offers a comprehensive set of HL7 FHIR (Fast Healthcare Interoperability Resources) APIs that allow third party developers to build applications by querying the patient medical records from CharmHealth EHR.

In adherence to the MU 2015 Edition certification criteria, APIs are implemented as per the FHIR Version 4.0.1 specification and the US Core Implementation Guide STU Version 3.1.1. These standardized APIs allow seamless transfer of patient heath information with third-party systems and make the application development simpler.

The APIs also support the Smart App Launch specification allowing the third-party applications to launch from inside or outside the CharmHealth EHR user interface.

FHIR Base URL


        

The base URL for accessing all the CharmHealth FHIR APIs is below.

https://ehr2.charmtracker.com/api/ehr/v2/fhir

Application Types


        

Developers can use these APIs to build different types of applications listed below.

  1. Patient Facing Application
  2. Provider Facing Application
  3. Backend Application

Patient Facing Application

Developers can use these APIs to build standalone patient facing applications by querying a specific patient record from CharmHealth EHR. Patients need to use their CharmHealth PHR account credential to authenticate the application to access their data.

Provider Facing Application

APIs can also be used for developing provider facing applications that can access multiple patient records. The providers need to use their CharmHealth EHR account credential to authenticate the provider facing application to access the patient records stored in their account.

Backend Application

Besides the Patient and Provider facing applications, the APIs can be used for backend services to perform actions like bulk export of patient records etc. As there is no user action involved, the APIs need to be authenticated using the SMART Backend Service Authorization specification.

Getting Started


        

For using CharmHealth APIs, first you have to register a developer account and choose an oAuth2 authentication option based on your needs.

Developer Account


        

To get a Developer Account, submit a request using the CharmHealth Certified API Access Request form. Provide your contact information and details about the application you are planning to build. On receiving your request, our representatives will contact you to discuss your requirements and assist you in signing our API License Agreement.

Once the api agreement is signed and the developer license is issued, we will provide you with a client ID and a client secret (only for confidential clients). The Client ID is used by CharmHealth EHR to verify the identity of the application and has a public visibility. The Client Secret is used to authorize the resources that can be accessed by the authenticated application.

OAuth Scopes

You can use any of the FHIR oAuth scopes below based on the type of your application.

  1. Patient Scopes
  2. User Scopes
  3. System Scopes
  4. Other Scopes

Patient Scopes

The scopes below are used for Patient facing applications.

Scopes Description
patient/AllergyIntolerance.read Allows READ access to allergy intolerance of a patient.
patient/Appointment.read Allows READ access to appointment of a patient.
patient/CarePlan.read Allows READ access to care plan of a patient.
patient/CareTeam.read Allows READ access to care team of a patient.
patient/Condition.read Allows READ access to condition of a patient.
patient/Device.read Allows READ access to device of a patient.
patient/DiagnosticReport.read Allows READ access to diagnostic report of a patient.
patient/DocumentReference.read Allows READ access to document reference of a patient.
patient/Encounter.read Allows READ access to encounter of a patient.
patient/FamilyMemberHistory.read Allows READ access to family member history of a patient.
patient/Goal.read Allows READ access to goal of a patient.
patient/Immunization.read Allows READ access to immunization of a patient.
patient/MedicationAdministration.read Allows READ access to medication administration of a patient.
patient/MedicationRequest.read Allows READ access to medication request of a patient.
patient/Observation.read Allows READ access to observation of a patient.
patient/Patient.read Allows READ access to demographics of a patient.
patient/Procedure.read Allows READ access to procedure of a patient.
patient/QuestionnaireResponse.read Allows READ access to questionnaire response of a patient.
patient/RelatedPerson.read Allows READ access to related person of a patient.

User Scopes

The scopes below are used for Provider facing applications.

Scopes Description
user/AllergyIntolerance.read Allows READ access to allergy intolerance of multiple patients.
user/Appointment.read Allows READ access to appointment of multiple patients.
user/CarePlan.read Allows READ access to care plan of multiple patients.
user/CareTeam.read Allows READ access to care team of multiple patients.
user/Condition.read Allows READ access to condition of multiple patients.
user/Device.read Allows READ access to device of multiple patients.
user/DiagnosticReport.read Allows READ access to diagnostic report of multiple patients.
user/DocumentReference.read Allows READ access to document reference of multiple patients.
user/Encounter.read Allows READ access to encounter of multiple patients.
user/FamilyMemberHistory.read Allows READ access to family member history of multiple patients.
user/Goal.read Allows READ access to goal of multiple patients.
user/Immunization.read Allows READ access to immunization of multiple patients.
user/Location.read Allows READ access to location of multiple patients.
user/MedicationAdministration.read Allows READ access to medication administration of multiple patients.
user/MedicationRequest.read Allows READ access to medication request of multiple patients.
user/Observation.read Allows READ access to observation of multiple patients.
user/Organization.read Allows READ access to organization of multiple patients.
user/Patient.read Allows READ access to demographics of multiple patients.
user/Practitioner.read Allows READ access to practitioner of multiple patients.
user/Procedure.read Allows READ access to procedure of multiple patients.
user/Provenance.read Allows READ access to provenance of multiple patients.
user/QuestionnaireResponse.read Allows READ access to questionnaire response of multiple patients.
user/RelatedPerson.read Allows READ access to related person of multiple patients.

System Scopes

The scopes below are used for Backend Service applications.

Scopes Description
system/AllergyIntolerance.read Allows READ access to allergy intolerance of multiple patients.
system/Appointment.read Allows READ access to appointment of multiple patients.
system/CarePlan.read Allows READ access to care plan of multiple patients.
system/CareTeam.read Allows READ access to care team of multiple patients.
system/Condition.read Allows READ access to condition of multiple patients.
system/Device.read Allows READ access to device of multiple patients.
system/DiagnosticReport.read Allows READ access to diagnostic report of multiple patients.
system/DocumentReference.read Allows READ access to document reference of multiple patients.
system/Encounter.read Allows READ access to encounter of multiple patients.
system/FamilyMemberHistory.read Allows READ access to family member history of multiple patients.
system/Goal.read Allows READ access to goal of multiple patients.
system/Immunization.read Allows READ access to immunization of multiple patients.
system/Location.read Allows READ access to location of multiple patients.
system/MedicationAdministration.read Allows READ access to medication administration of multiple patients.
system/MedicationRequest.read Allows READ access to medication request of multiple patients.
system/Observation.read Allows READ access to observation of multiple patients.
system/Organization.read Allows READ access to organization of multiple patients.
system/Patient.read Allows READ access to demographics of multiple patients.
system/Practitioner.read Allows READ access to practitioner of multiple patients.
system/Procedure.read Allows READ access to procedure of multiple patients.
system/Provenance.read Allows READ access to provenance of multiple patients.
system/QuestionnaireResponse.read Allows READ access to questionnaire response of multiple patients.
system/RelatedPerson.read Allows READ access to related person of multiple patients.

Other scopes

You can also use a couple of other FHIR scopes below based on your needs.

Scopes Description
launch Used for sending the launch context to the provider facing applications that are invoked from CharmHealth EHR
launch/patient Used for patient selection in standalone patient facing applications
openid Permission to retrieve information about the current logged-in user
fhirUser Indicates that one accessing is FHIR user
offline_access Request a refresh_token that can be used to obtain a new access token to replace an expired one, even after the end-user no longer is online after the access token expires.

Authentication


        

CharmHealth EHR APIs are authenticated using OAuth 2, an open authorization protocol that grants third party applications limited access to users' account. The authentication and authorization are facilitated only between the end-user and the CharmHealth HTTPS service. OAuth 2 provides dependable security for your application data that can be accessed via web and mobile devices.

  1. Provider/Patient Facing Applications
  2. Backend Applications

For Provider/Patient Facing Applications:

Provider and Patient facing applications can obtain the OAuth access token by following the steps below.

a) Confidential Client

If your application can store the 'client_secret' securely, then you can register as a Confidential Client. As part of this workflow, you get a 'refresh_token' that is reusable. You can store that 'refresh_token' in your application and use that to regenerate an access_token whenever it expires.

Sample Request

GET https://accounts.charmtracker.com/oauth/v2/auth?scope=patient/Patient.read&client_id={client_id}&state=tempstate&response_type=code&redirect_uri=https://app.example.com/oauth

Sample Response

https://app.example.com/oauth?state=tempstate&code=1000.47b8f8decdf76c0

1. Get an Authorization Grant

To get authorization grant from users, make a GET request to the URL below with associated parameters.

URL: https://accounts.charmtracker.com/oauth/v2/auth

Params:

Sample Response

{ "access_token": "1000.4143fa1dc0797ec92bf3", "refresh_token": "1000.388aa9e80701b1a23c8", "expires_in_sec": 3600, "token_type": "Bearer", "expires_in": 3600000, "scope": "patient/Patient.read" }

2. Get an Access Token

After getting an authorization grant, POST it to the API below to get the access token and the refresh token.

URL: https://accounts.charmtracker.com/oauth/v2/token

Params:

Note: expires_in parameter in response contains expiry time of the access_token in milliseconds.

Sample Response

{ "access_token": "1000.43fa91dc0797ec92bg", "expires_in_sec": 3600, "token_type": "Bearer", "expires_in": 3600000, "scope": "patient/Patient.read" }

3.Regenerating the Access Token with the Refresh Token

Once the access token expires, it can be regenerated using the refresh token by making a POST call to the API below.

URL: https://accounts.charmtracker.com/oauth/v2/token

Params:

Sample Response

{"status":"success"}

4.Revoking a Refresh Token

A Refresh Token can be revoked by calling the API below.

URL: https://accounts.charmtracker.com/oauth/v2/token/revoke

Params: token = <Refresh Token>

b) Public Client


        

If your application cannot store the 'client_secret' securely (like a browser based app), then you can register as a Public Client.

CharmHealth EHR supports Proof Key for Code Exchange (PKCE), a standardized cross-platform technique for clients to mitigate the threat of authorization code interception or injection. It uses the S256 code_challenge_method.

Sample Request

GET https://accounts.charmtracker.com/oauth/v2/auth?scope=patient/Patient.read&client_id={client_id}&state=tempstate&response_type=code&redirect_uri=https://app.example.com/oauth&code_challenge=sds6s8sdd9s&code_challenge_method=SHA256

Sample Response

https://app.example.com/oauth?state=tempstate&code=1000.47b8f8decdf76c0

1. Get an Authorization Grant

To get authorization grant from users, make a GET request to the URL below with associated parameters.

Along with that, you have to send the code_challenge parameter, which contains the SHA256 encoded value of the code_verifier that you have generated.

URL: https://accounts.charmtracker.com/oauth/v2/auth

Params:

Sample Request

POST https://accounts.charmtracker.com/oauth/v2/token?code=1000.8d105dc4c9ae9&code_verifier=d1ee-b24fce79-5565a-f0f7&grant_type=authorization_code&redirect_uri=https%3A%2F%2Finferno.healthit.gov%2Fsuites%2Fcustom%2Fsmart%2Fredirect

Sample Response

{ "access_token": "1000.b4cdf7a929281626ddb", "refresh_token": "1000.f6d7cc51a33w190c62", "need_patient_banner": "false", "scope": "patient/Patient.read", "id_token": "eyLJopvNGcFc_Orfxc-Q9mqvc8CLzFvSNNr6LUkZkaM6uVw", "smart_style_url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/styles/smart-style", "api_domain": "api.charmtracker.com", "token_type": "Bearer", "expires_in": 3600 }

2. Get an Access Token

After getting an authorization grant, POST it to the API below to get the access token and the refresh token. The code should be sent along the code_verifier generated in the first step

URL: https://accounts.charmtracker.com/oauth/v2/token

Params:

Note: expires_in parameter in response contains expiry time of the access_token in milliseconds.

Native Applications


        

We support issuing the initial refresh token securely to native applications.

To use this feature, you need to register a client in CharmHealth with your app specific Custom URL Scheme (like myapp://callback). The normal OAuth flow is followed for authenticating the native applications. The only difference is, you need to send your custom URL scheme as the value for the 'redirect-uri' parameter.

Once the authentication is successful, the code and tokens are securely posted to your native application using the custom URL scheme provided.

Backend Applications


        

Backend applications that do not have user intervention can use the SMART Backend Service Authorization. The client needs to generate a public key and share it with CharmHealth as a JWK (JSON Web Key) URL, along with a list of oauth scopes that need to be pre-authorized.

1. Creating the JWT

JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object.

JWT consists of two parts: Header and Payload

Generate a JWT token using the RSA private key and SHA-384 hashing as specified in the RS384 algorithm.

Sample Request

POST https://accounts.charmtracker.com/oauth/v2/token?client_assertion=eyJ0eXAiOiJKV1QiAOBDZpB1E-i0&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer&grant_type=client_credentials&scope=system%2F%2A.read

Sample Response

{ "access_token": "1000.7729b9fb8b46086", "scope": "system/*.read", "api_domain": "api.charmtracker.com", "token_type": "Bearer", "expires_in": 3600 }

2. Obtaining Access Token by posting JWT to Token Endpoint

After generating the JWT token, it is added to the token endpoint request, to obtain the access token/p>

URL: https://accounts.charmtracker.com/oauth/v2/token

Params:

Note: expires_in parameter in response contains expiry time of the access_token in milliseconds.

API Key


        

As an additional security, the practice administrator needs to authorize the third-party applications to access their data using API. To do this, the practice admin needs to add the client_id of the application developer under the Settings > Account > API Keys section of their CharmHealth EHR account.

Response Codes


        

CharmHealth EHR uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Status Code Description
200 OK
201 Created
202 Accepted
400 Bad request
401 Unauthorized (Invalid AuthToken)
404 URL Not Found
405 Method Not Allowed (Method you have called is not supported for the invoked API)
429 Rate Limit Exceeded (API usage limit exceeded)
500 Internal Error

Capability Statement


        

Fetches authorization endpoint URLs for the authorization requests. It also fetches the generic details of the supported resources.

Refer this link for more details

SMART Configuration

Request Example

    
$ curl --location --request GET 'https://ehr2.charmtracker.com/api/ehr/v2/fhir/.well-known/smart-configuration' \ -H 'Authorization: Bearer ba4604e8e433g9c892e360d53463oec5'

Response Example

HTTP/1.1 200 OK { "response_types_supported": [ "code", "token" ], "capabilities": [ "launch-standalone", "client-confidential-symmetric", "client-public", "permission-patient", "launch-ehr", "context-ehr-patient", "context-standalone-patient", "permission-user", "permission-offline", "permission-online", "context-banner", "context-style", "sso-openid-connect" ], "grant_types_supported": [ "authorization_code", "implicit", "refresh_token", "urn:ietf:params:oauth:grant-type:device_code", "urn:ietf:params:oauth:grant-type:jwt-bearer" ], "revocation_endpoint": "https://accounts.charmtracker.com/oauth/v2/token/revoke", "scopes_supported": [ "email", "profile", "openid" ], "issuer": "https://accounts.charmtracker.com", "authorization_endpoint": "https://accounts.charmtracker.com/oauth/v2/auth", "userinfo_endpoint": "https://accounts.charmtracker.com/oauth/v2/userinfo", "device_authorization_endpoint": "https://accounts.charmtracker.com/oauth/v3/device/code", "claims_supported": [ "aud", "email", "email_verified", "exp", "iat", "iss", "sid", "sub", "at_hash", "kid", "profile", "picture", "first_name", "name", "last_name", "gender" ], "code_challenge_methods_supported": [ "S256" ], "jwks_uri": "https://accounts.charmtracker.com/oauth/v2/keys", "subject_types_supported": [ "public" ], "id_token_signing_alg_values_supported": [ "RS256", "RS384" ], "token_endpoint_auth_methods_supported": [ "client_secret_basic", "client_secret_post", "private_key_jwt" ], "response_modes_supported": [ "query", "fragment" ], "token_endpoint": "https://accounts.charmtracker.com/oauth/v2/token" }

Fetches the configuration related details

API URL:

GET /.well-known/smart-configuration

Metadata

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/metadata -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "CapabilityStatement", "version": "4.0.1", "status": "draft", "experimental": true, "date": "2023-11-01T13:23:03+05:30", "kind": "instance", "software": { "name": "CharmHealth EHR", "version": "1.2" }, "implementation": { "description": "CharmHealth USCDI on FHIR Server", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir" }, "fhirVersion": "4.0.1", "format": [ "json" ], "rest": [ { "mode": "server", "security": { "extension": [ { "url": "http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris", "extension": [ { "url": "authorize", "valueUri": "https://accounts.charmtracker.com/oauth/v2/auth" }, { "url": "token", "valueUri": "https://accounts.charmtracker.com/oauth/v2/token" }, { "url": "revoke", "valueUri": "https://accounts.charmtracker.com/oauth/v2/token/revoke" } ] } ], "service": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/restful-security-service", "code": "SMART-on-FHIR" } ], "text": "OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)" } ] }, "resource": [ { "type": "Patient", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "_id", "type": "token" }, { "name": "birthdate", "type": "date" }, { "name": "family", "type": "string" }, { "name": "gender", "type": "token" }, { "name": "given", "type": "string" }, { "name": "identifier", "type": "token" }, { "name": "name", "type": "string" } ] }, { "type": "AllergyIntolerance", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "clinical-status", "type": "token" }, { "name": "patient", "type": "reference" } ] }, { "type": "Goal", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "target-date", "type": "date" }, { "name": "lifecycle-status", "type": "token" }, { "name": "patient", "type": "reference" } ] }, { "type": "CarePlan", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "category", "type": "token" }, { "name": "date", "type": "date" }, { "name": "patient", "type": "reference" }, { "name": "status", "type": "token" } ] }, { "type": "CareTeam", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "patient", "type": "reference" }, { "name": "status", "type": "token" } ] }, { "type": "Condition", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "category", "type": "token" }, { "name": "clinical-status", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "onset-date", "type": "date" }, { "name": "code", "type": "token" } ] }, { "type": "Device", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "patient", "type": "reference" }, { "name": "type", "type": "token" } ] }, { "type": "DiagnosticReport", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "status", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "category", "type": "token" }, { "name": "code", "type": "token" }, { "name": "date", "type": "date" } ] }, { "type": "DocumentReference", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "_id", "type": "token" }, { "name": "status", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "category", "type": "token" }, { "name": "type", "type": "token" }, { "name": "date", "type": "date" }, { "name": "period", "type": "date" } ] }, { "type": "Immunization", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "patient", "type": "reference" }, { "name": "status", "type": "token" }, { "name": "date", "type": "date" } ] }, { "type": "Medication", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ] }, { "type": "MedicationRequest", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchInclude": [ "MedicationRequest:medication" ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "status", "type": "token" }, { "name": "intent", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "encounter", "type": "reference" }, { "name": "authoredon", "type": "date" } ] }, { "type": "Observation", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-weight-for-height", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab", "http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age", "http://hl7.org/fhir/us/core/StructureDefinition/us-core-pulse-oximetry", "http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile", "http://hl7.org/fhir/StructureDefinition/bp", "http://hl7.org/fhir/StructureDefinition/bodyheight", "http://hl7.org/fhir/StructureDefinition/bodyweight", "http://hl7.org/fhir/StructureDefinition/heartrate", "http://hl7.org/fhir/StructureDefinition/resprate", "http://hl7.org/fhir/StructureDefinition/bodytemp" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "clinical-status", "type": "token" }, { "name": "patient", "type": "reference" } ] }, { "type": "Procedure", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "status", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "date", "type": "date" }, { "name": "code", "type": "token" } ] }, { "type": "Encounter", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "_id", "type": "token" }, { "name": "class", "type": "token" }, { "name": "date", "type": "date" }, { "name": "identifier", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "status", "type": "token" }, { "name": "type", "type": "token" } ] }, { "type": "Organization", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "name", "type": "string" }, { "name": "address", "type": "string" } ] }, { "type": "Practitioner", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "name", "type": "string" }, { "name": "identifier", "type": "token" } ] }, { "type": "Provenance", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ] }, { "type": "Location", "supportedProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "name", "type": "string" }, { "name": "address", "type": "string" }, { "name": "address-city", "type": "string" }, { "name": "address-state", "type": "string" }, { "name": "address-postalcode", "type": "string" } ] }, { "type": "MedicationAdministration", "supportedProfile": [ "http://hl7.org/fhir/R4/medicationadministration.html" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "patient", "type": "reference" }, { "name": "status", "type": "token" }, { "name": "date", "type": "date" } ] }, { "type": "QuestionnaireResponse", "supportedProfile": [ "http://hl7.org/fhir/R4/questionnaireresponse.html" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "patient", "type": "reference" }, { "name": "status", "type": "token" }, { "name": "date", "type": "date" } ] }, { "type": "Appointment", "supportedProfile": [ "https://hl7.org/fhir/R4/appointment" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchParam": [ { "name": "_id", "type": "token" }, { "name": "identifier", "type": "token" }, { "name": "actor", "type": "reference" }, { "name": "date", "type": "date" }, { "name": "status", "type": "token" } ] }, { "type": "FamilyMemberHistory", "supportedProfile": [ "https://hl7.org/fhir/R4/familymemberhistory" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchParam": [ { "name": "_id", "type": "token" }, { "name": "patient", "type": "reference" }, { "name": "date", "type": "date" } ] }, { "type": "RelatedPerson", "supportedProfile": [ "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ], "interaction": [ { "code": "search-type" }, { "code": "read" }, { "code": "vread" }, { "code": "history-instance" } ], "searchRevInclude": [ "Provenance:target" ], "searchParam": [ { "name": "patient", "type": "reference" }, { "name": "address", "type": "string" }, { "name": "name", "type": "string" } ] }, { "type": "Group", "operation": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "export", "definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export" } ] } ], "operation": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHOULD" } ], "name": "export", "definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export" } ] } ] }

Fetches the metadata for all resources

API URL:

GET /metadata

AllergyIntolerance


        

Use these apis to fetch the AllergyIntolerance data recorded for patients.

These apis are in conformance to the US Core AllergyIntolerance Profile

List AllergyIntolerance

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/AllergyIntolerance?patient=Patient/1036765000000061003 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "471356ab-1cf3-44b3-abf2-da0aed536b18", "meta": { "lastUpdated": "2022-11-13T22:36:04.918-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/AllergyIntolerance?patient=1036765000000061003" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/AllergyIntolerance/1036765000000062038", "resource": { "resourceType": "AllergyIntolerance", "id": "1036765000000062038", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ], "text": "The subject is currently experiencing, or is at risk of, a reaction to the identified substance." }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ], "text": "A high level of certainty about the propensity for a reaction to the identified substance, which may include clinical evidence by testing or rechallenge." }, "type": "allergy", "category": [ "medication" ], "criticality": "low", "code": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "2670", "display": "Codeine" } ], "text": "Codeine" }, "patient": { "reference": "Patient/1036765000000061003" }, "onsetString": "2006-05-01", "recordedDate": "2022-10-18T00:00:00-07:00", "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "267036007", "display": "Shortness of Breath" } ], "text": "Shortness of Breath" } ] } ] } } ] }

Fetches a bundle of AllergyIntolerance resources based on query parameters.

API URL:

GET /AllergyIntolerance

QUERY PARAMETERS:

Name Type Required Description
patient string optional

The patient who has the allergy or intolerance.

Refer Identifer for input format.

Required for patient facing applications

clinical-status string optional

The clinical status of the allergy or intolerance.

Accepted values: active | inactive | resolved

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get AllergyIntolerance By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/AllergyIntolerance/1036765000000062038 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "AllergyIntolerance", "id": "1036765000000062038", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ], "text": "The subject is currently experiencing, or is at risk of, a reaction to the identified substance." }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ], "text": "A high level of certainty about the propensity for a reaction to the identified substance, which may include clinical evidence by testing or rechallenge." }, "type": "allergy", "category": [ "medication" ], "criticality": "low", "code": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "2670", "display": "Codeine" } ], "text": "Codeine" }, "patient": { "reference": "Patient/1036765000000061003" }, "onsetString": "2006-05-01", "recordedDate": "2022-10-18T00:00:00-07:00", "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "267036007", "display": "Shortness of Breath" } ], "text": "Shortness of Breath" } ] } ] }

Fetches a specific AllergyIntolerance resource.

API URL:

GET /AllergyIntolerance/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the allergy intolerance.

Search AllergyIntolerance

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/AllergyIntolerance/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000061003","clinical-status": "active"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "6828c28b-84a2-4f18-b471-e315fb63fade", "meta": { "lastUpdated": "2022-11-13T22:36:05.399-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/AllergyIntolerance/_search?patient=1036765000000061003" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/AllergyIntolerance/1036765000000062038", "resource": { "resourceType": "AllergyIntolerance", "id": "1036765000000062038", "clinicalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical", "code": "active", "display": "Active" } ], "text": "The subject is currently experiencing, or is at risk of, a reaction to the identified substance." }, "verificationStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification", "code": "confirmed", "display": "Confirmed" } ], "text": "A high level of certainty about the propensity for a reaction to the identified substance, which may include clinical evidence by testing or rechallenge." }, "type": "allergy", "category": [ "medication" ], "criticality": "low", "code": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "2670", "display": "Codeine" } ], "text": "Codeine" }, "patient": { "reference": "Patient/1036765000000061003" }, "onsetString": "2006-05-01", "recordedDate": "2022-10-18T00:00:00-07:00", "reaction": [ { "manifestation": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "267036007", "display": "Shortness of Breath" } ], "text": "Shortness of Breath" } ] } ] } } ] }

Fetches a bundle of AllergyIntolerance resources based on query parameters.

API URL:

POST /AllergyIntolerance/_search

QUERY PARAMETERS:

Name Type optional Description
patient string optional

The patient who has the allergy or intolerance.

Refer Identifer for input format.

Required for patient facing applications

clinical-status string optional

The clinical status of the allergy or intolerance.

Accepted values: active | inactive | resolved

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Appointment


        

Use these apis to fetch the Appointment data recorded for patients.

These apis are in conformance to the US Core Appointment Profile

List Appointment

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Appointment?actor=Patient/100002000000006721 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "07471ffc-78e3-412c-a872-bf7373e960e9", "meta": { "lastUpdated": "2023-10-30T18:40:40.657+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Appointment?actor=Patient/100002000000006721" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Appointment/100002000000010027", "resource": { "resourceType": "Appointment", "id": "100002000000010027", "meta": { "lastUpdated": "2023-10-30T18:32:11.637+05:30" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "100002000000010027" } ], "status": "booked", "serviceType": [ { "text": "Follow up Psychiatry consult" } ], "appointmentType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0276", "code": "FOLLOWUP", "display": "A follow up visit" } ], "text": "A follow up visit" }, "description": "In Person", "start": "2023-10-12T01:30:00.000+05:30", "end": "2023-10-12T02:00:00.000+05:30", "comment": "Cold, Fever", "patientInstruction": "Fill out the questionnaires", "participant": [ { "actor": { "reference": "Practitioner/100002000000000117" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Patient/100002000000006721" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Location/100002000000000177" }, "required": "required", "status": "accepted" } ] } } ] }

Fetches a bundle of Appointment resources based on query parameters.

API URL:

GET /Appointment

QUERY PARAMETERS:

Name Type Required Description
identifier string optional

Appointment Reference.

Refer Identifer for input format.

actor string optional

Actor (Patient, Practitioner, Location) Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

status string optional

The status of the appointment.

Accepted values: booked | noshow | cancelled

date string optional

Date of the appointment.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Appointment By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Appointment/1036765000000102015 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Appointment", "id": "100002000000010027", "meta": { "lastUpdated": "2023-10-30T18:32:11.637+05:30" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "100002000000010027" } ], "status": "booked", "serviceType": [ { "text": "Follow up Psychiatry consult" } ], "appointmentType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0276", "code": "FOLLOWUP", "display": "A follow up visit" } ], "text": "A follow up visit" }, "description": "In Person", "start": "2023-10-12T01:30:00.000+05:30", "end": "2023-10-12T02:00:00.000+05:30", "comment": "Cold, Fever", "patientInstruction": "Fill out the questionnaires", "participant": [ { "actor": { "reference": "Practitioner/100002000000000117" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Patient/100002000000006721" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Location/100002000000000177" }, "required": "required", "status": "accepted" } ] }

Fetches a specific Appointment resource.

API URL:

GET /Appointment/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the appointment.

Search Appointment

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Appointment/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"actor": "Patient/100002000000006721","date": "gt2023-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "07471ffc-78e3-412c-a872-bf7373e960e9", "meta": { "lastUpdated": "2023-10-30T18:40:40.657+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Appointment?actor=Patient/100002000000006721&date=gt2023-08-10T12:30:00-05:30" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Appointment/100002000000010027", "resource": { "resourceType": "Appointment", "id": "100002000000010027", "meta": { "lastUpdated": "2023-10-30T18:32:11.637+05:30" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "100002000000010027" } ], "status": "booked", "serviceType": [ { "text": "Follow up Psychiatry consult" } ], "appointmentType": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0276", "code": "FOLLOWUP", "display": "A follow up visit" } ], "text": "A follow up visit" }, "description": "In Person", "start": "2023-10-12T01:30:00.000+05:30", "end": "2023-10-12T02:00:00.000+05:30", "comment": "Cold, Fever", "patientInstruction": "Fill out the questionnaires", "participant": [ { "actor": { "reference": "Practitioner/100002000000000117" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Patient/100002000000006721" }, "required": "required", "status": "accepted" }, { "actor": { "reference": "Location/100002000000000177" }, "required": "required", "status": "accepted" } ] } } ] }

Fetches a bundle of Appointment resources based on query parameters.

API URL:

POST /Appointment/_search

QUERY PARAMETERS:

Name Type Required Description
identifier string optional

Appointment Reference.

Refer Identifer for input format.

actor string optional

Actor (Patient, Practitioner, Location) Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

The status of the appointment.

Accepted values: booked | noshow | cancelled

date string optional

Date of the appointment.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

CarePlan


        

Use these apis to fetch the CarePlan data (Assessment Notes and Treatment Notes) recorded for patients.

These apis are in conformance to the US Core CarePlan Profile

List CarePlan

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/CarePlan?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "b726ff8c-688d-454a-b073-cff32ba4c2b4", "meta": { "lastUpdated": "2022-11-13T22:36:10.393-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CarePlan?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CarePlan/1036765000000102079", "resource": { "resourceType": "CarePlan", "id": "1036765000000102079", "text": { "status": "additional", "div": "
Treatment Notes
Cervical / upper extremity EMGHave prescriptions filled and take as directed\nContinue current medication\n
" }, "status": "active", "intent": "order", "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category", "code": "assess-plan" } ] } ], "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102079" } } } ] }

Fetches a bundle of CarePlan resources based on query parameters.

API URL:

GET /CarePlan

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

Status of the care plan

Accepted values: draft | active | on-hold | revoked | completed | entered-in-error | unknown

date string optional

Date of the care plan.

Refer link for input format.

category string optional

Category of the care plan.

Accepted values: assess-plan

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get CarePlan By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/CarePlan/1036765000000102063 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "CarePlan", "id": "1036765000000102063", "text": { "status": "additional", "div": "
Assessment Notes
65 year old man with h/o PAF, HTN, CVA now presents with visual field deficits and spatial perception difficulty. Story of the sudden onset of neurologic deficits while awake, eating lunch in the setting of chronic intermittent atrial fibrillation is most consistent with embolic stroke. Infarction was confirmed with CT showing lesion in R PCA distribution. Patient has multiple risk factors for cardiogenic embolization from afib: h/o previous stroke, hypertension, age over 65, increased LV size, and valvular disease. Given his carotid disease artery-artery embolization is possibility but less likely becasue 1) less common than cardiac embolization and 2) his current infarct is in the posterior curculation.\nVisual disturbances could also be caused by temporal arteritis: though he does have a temporal headache, he has no tenderness and his visual defect is a bilateral loss of the left visual fields which is consistent with a cortical as opposed to a retinal injury.\n
Treatment Notes
Albert has received a significant amount of psychoeducation within his therapy session. The therapist will begin to use dialectical behavioral therapy techniques to address Albert emotion dysregulation. Albert also agreed to continue to hold family therapy sessions with his wife. Staff will continue to monitor Albert regularly in the interest of patient care and his past medical history.\n
" }, "status": "active", "intent": "order", "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category", "code": "assess-plan" } ] } ], "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102063" } }

Fetches a specific CarePlan resource.

API URL:

GET /CarePlan/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Care Plan.

Search CarePlan

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/CarePlan/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","category": "assess-plan"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "8bdfe6c9-798f-4900-b008-45eff7e70f02", "meta": { "lastUpdated": "2022-11-13T22:36:10.852-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CarePlan/_search?patient=1036765000000056009&category=assess-plan" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CarePlan/1036765000000102079", "resource": { "resourceType": "CarePlan", "id": "1036765000000102079", "text": { "status": "additional", "div": "
Treatment Notes
Cervical / upper extremity EMGHave prescriptions filled and take as directed\nContinue current medication\n
" }, "status": "active", "intent": "order", "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category", "code": "assess-plan" } ] } ], "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102079" } } } ] }

Fetches a bundle of CarePlan resources based on query parameters.

API URL:

POST /CarePlan/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

Status of the care plan

Accepted values: draft | active | on-hold | revoked | completed | entered-in-error | unknown

date string optional

Date of the care plan.

Refer link for input format.

category string optional

Category of the care plan.

Accepted values: assess-plan

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

CareTeam


        

Use these apis to fetch the CareTeam data recorded for patients.

These apis are in conformance to the US Core CareTeam Profile

List CareTeam

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/CareTeam?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "b73c6d11-6c08-47f5-bfba-40b2858e0b90", "meta": { "lastUpdated": "2022-11-13T22:36:14.835-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CareTeam?patient=Patient/1036765000000056009&status=active" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CareTeam/1036765000000056009", "resource": { "resourceType": "CareTeam", "id": "1036765000000056009", "status": "active", "subject": { "reference": "Patient/1036765000000056009" }, "participant": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "309343006", "display": "Physician" } ] } ], "member": { "reference": "Practitioner/1036765000000021021", "display": "Albert Davis" } }, { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "309343006", "display": "Physician" } ] } ], "member": { "reference": "Practitioner/1036765000000031651", "display": "Tracy Davis" } } ] } } ] }

Fetches a bundle of CareTeam resources based on query parameters.

API URL:

GET /CareTeam

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

Status of the care plan

Accepted values: proposed | active | suspended | inactive | entered-in-error

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get CareTeam By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/CareTeam/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "CareTeam", "id": "1036765000000056009", "status": "active", "subject": { "reference": "Patient/1036765000000056009" }, "participant": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "309343006", "display": "Physician" } ] } ], "member": { "reference": "Practitioner/1036765000000021021", "display": "Albert Davis" } }, { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "309343006", "display": "Physician" } ] } ], "member": { "reference": "Practitioner/1036765000000031651", "display": "Tracy Davis" } } ] }

Fetches a specific CareTeam resource.

API URL:

GET /CareTeam/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the care team.

Search CareTeam

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/CareTeam/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","status": "active"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "1f2895c9-356a-4643-a7bb-6a3e849c0b07", "meta": { "lastUpdated": "2022-11-13T22:36:14.412-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CareTeam/_search?patient=1036765000000056009&status=active" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/CareTeam/1036765000000056009", "resource": { "resourceType": "CareTeam", "id": "1036765000000056009", "status": "active", "subject": { "reference": "Patient/1036765000000056009" }, "participant": [ { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "309343006", "display": "Physician" } ] } ], "member": { "reference": "Practitioner/1036765000000021021", "display": "Albert Davis" } }, { "role": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "309343006", "display": "Physician" } ] } ], "member": { "reference": "Practitioner/1036765000000031651", "display": "Tracy Davis" } } ] } } ] }

Fetches a bundle of CareTeam resources based on query parameters.

API URL:

POST /CareTeam/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

Status of the care plan

Accepted values: proposed | active | suspended | inactive | entered-in-error

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Condition


        

Use these apis to fetch the Condition (Diagnoses) data recorded for patients.

These apis are in conformance to the US Core Condition Profile

List Condition

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Condition?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "de5b7d93-fbfb-4130-a6bb-ab0a9f832d8d", "meta": { "lastUpdated": "2022-11-13T22:36:20.131-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Condition?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Condition/1036765000000154143", "resource": { "resourceType": "Condition", "id": "1036765000000154143", "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": "There is sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition." }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "A point in time diagnosis (e.g. from a physician or nurse) in context of an encounter." } ], "code": { "coding": [ { "display": "Head Pain" } ], "text": "Head Pain" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102095" }, "onsetString": "2022-06-17", "recordedDate": "2022-11-07T00:00:00-08:00", "recorder": { "reference": "Practitioner/1036765000000021021" } } } ] }

Fetches a bundle of Condition resources based on query parameters.

API URL:

GET /Condition

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

clinical-status string optional

The clinical status of the condition.

Accepted values: active | inactive | resolved

category string optional

Category of the care plan.

Accepted values: problem-list-item | encounter-diagnosis | health-concern

code string optional

Identification of the condition, problem or diagnosis.

Include codes from SNOMED list.

onset-date string optional

Estimated date of the condition.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Condition By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Condition/1036765000000154143 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Condition", "id": "1036765000000154143", "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": "There is sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition." }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "A point in time diagnosis (e.g. from a physician or nurse) in context of an encounter." } ], "code": { "coding": [ { "display": "Head Pain" } ], "text": "Head Pain" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102095" }, "onsetString": "2022-06-17", "recordedDate": "2022-11-07T00:00:00-08:00", "recorder": { "reference": "Practitioner/1036765000000021021" } }

Fetches a specific Condition resource.

API URL:

GET /Condition/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the condition.

Search Condition

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Condition/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","clinical-status": "active","onset-date": "gt2022-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "72dbd239-e2cd-4ea8-8c6f-ff61b59e8c67", "meta": { "lastUpdated": "2022-11-13T22:36:20.580-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Condition/_search?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Condition/1036765000000154143", "resource": { "resourceType": "Condition", "id": "1036765000000154143", "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": "There is sufficient diagnostic and/or clinical evidence to treat this as a confirmed condition." }, "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/condition-category", "code": "encounter-diagnosis", "display": "Encounter Diagnosis" } ], "text": "A point in time diagnosis (e.g. from a physician or nurse) in context of an encounter." } ], "code": { "coding": [ { "display": "Head Pain" } ], "text": "Head Pain" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102095" }, "onsetString": "2022-06-17", "recordedDate": "2022-11-07T00:00:00-08:00", "recorder": { "reference": "Practitioner/1036765000000021021" } } } ] }

Fetches a bundle of Condition resources based on query parameters.

API URL:

POST /Condition/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

clinical-status string optional

The clinical status of the condition.

Accepted values: active | inactive | resolved

category string optional

Category of the care plan.

Accepted values: problem-list-item | encounter-diagnosis | health-concern

code string optional

Identification of the condition, problem or diagnosis.

Include codes from SNOMED list.

onset-date string optional

Estimated date of the condition.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Device


        

Use these apis to fetch the Device implanted for patients.

These apis are in conformance to the US Core Device Profile

List Device

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Device?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "3cb9c544-299b-49b7-b889-ffc62cee7ba6", "meta": { "lastUpdated": "2022-11-13T22:36:22.945-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Device?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Device/1036765000000103285", "resource": { "resourceType": "Device", "id": "1036765000000103285", "meta": { "lastUpdated": "2022-11-02T02:02:18.059-07:00" }, "udiCarrier": [ { "deviceIdentifier": "08717648200274", "carrierHRF": "=/08717648200274=,000025=A99972312345600=>014032=}013032&,1000000000000XYZ123" } ], "status": "active", "distinctIdentifier": "=/08717648200274=,000025=A99972312345600=>014032=}013032&,1000000000000XYZ123", "manufacturer": "ABBOTT VASCULAR INC.", "manufactureDate": "2013-02-01T00:00:00-08:00", "expirationDate": "2014-02-01T00:00:00-08:00", "lotNumber": "000000000000XYZ123", "serialNumber": "000025", "deviceName": [ { "name": "Drug-eluting coronary artery stent, non-bioabsorbable-polymer-coated", "type": "user-friendly-name" } ], "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "182588009", "display": "Spinal frame" } ] }, "version": [ { "value": "1145350-28" } ], "patient": { "reference": "Patient/1036765000000056009" }, "note": [ { "text": "Implanted spinal frame to support the patient to walk." } ] } } ] }

Fetches a bundle of Device resources based on query parameters.

API URL:

GET /Device

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

type string optional

The kind or type of device.

Include codes from SNOMED list.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Device By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Device/1036765000000103285 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Device", "id": "1036765000000103285", "meta": { "lastUpdated": "2022-11-02T02:02:18.059-07:00" }, "udiCarrier": [ { "deviceIdentifier": "08717648200274", "carrierHRF": "=/08717648200274=,000025=A99972312345600=>014032=}013032&,1000000000000XYZ123" } ], "status": "active", "distinctIdentifier": "=/08717648200274=,000025=A99972312345600=>014032=}013032&,1000000000000XYZ123", "manufacturer": "ABBOTT VASCULAR INC.", "manufactureDate": "2013-02-01T00:00:00-08:00", "expirationDate": "2014-02-01T00:00:00-08:00", "lotNumber": "000000000000XYZ123", "serialNumber": "000025", "deviceName": [ { "name": "Drug-eluting coronary artery stent, non-bioabsorbable-polymer-coated", "type": "user-friendly-name" } ], "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "182588009", "display": "Spinal frame" } ] }, "version": [ { "value": "1145350-28" } ], "patient": { "reference": "Patient/1036765000000056009" }, "note": [ { "text": "Implanted spinal frame to support the patient to walk." } ] }

Fetches a specific Device resource

API URL:

GET /Device/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the device.

Search Device

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Device/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","type": "182588009"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "bd56e839-5547-4f65-a4f7-038ecbae915e", "meta": { "lastUpdated": "2022-11-13T22:36:23.311-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Device/_search?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Device/1036765000000103285", "resource": { "resourceType": "Device", "id": "1036765000000103285", "meta": { "lastUpdated": "2022-11-02T02:02:18.059-07:00" }, "udiCarrier": [ { "deviceIdentifier": "08717648200274", "carrierHRF": "=/08717648200274=,000025=A99972312345600=>014032=}013032&,1000000000000XYZ123" } ], "status": "active", "distinctIdentifier": "=/08717648200274=,000025=A99972312345600=>014032=}013032&,1000000000000XYZ123", "manufacturer": "ABBOTT VASCULAR INC.", "manufactureDate": "2013-02-01T00:00:00-08:00", "expirationDate": "2014-02-01T00:00:00-08:00", "lotNumber": "000000000000XYZ123", "serialNumber": "000025", "deviceName": [ { "name": "Drug-eluting coronary artery stent, non-bioabsorbable-polymer-coated", "type": "user-friendly-name" } ], "type": { "coding": [ { "system": "http://snomed.info/sct", "code": "182588009", "display": "Spinal frame" } ] }, "version": [ { "value": "1145350-28" } ], "patient": { "reference": "Patient/1036765000000056009" }, "note": [ { "text": "Implanted spinal frame to support the patient to walk." } ] } } ] }

Fetches a bundle of Device resources based on query parameters.

API URL:

POST /Device/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

type string optional

The kind or type of device.

Include codes from SNOMED list.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

DiagnosticReport


        

Use these apis to fetch the Images and Lab Results recorded for patients.

These apis are in conformance to the US Core profiles below.

List DiagnosticReport

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/DiagnosticReport?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "b2a711be-a9f1-41ca-8c89-679b78f5d592", "meta": { "lastUpdated": "2022-11-13T22:36:27.804-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DiagnosticReport?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DiagnosticReport/1036765000000116469-LAB", "resource": { "resourceType": "DiagnosticReport", "id": "1036765000000116469-LAB", "meta": { "lastUpdated": "2022-11-02T02:01:42.527-07:00" }, "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v2-0074", "code": "LAB", "display": "Laboratory" } ] } ], "code": { "coding": [ { "system": "http://loinc.org", "display": "Cortisol" } ], "text": "Cortisol" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "effectiveDateTime": "2022-11-02T00:00:00-07:00", "issued": "2022-11-02T00:00:00.000-07:00", "performer": [ { "reference": "Practitioner/1036765000000021021" } ], "result": [ { "reference": "Observation/1036765000000116481-lab", "display": "cortisol" } ], "presentedForm": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "unknown" } ] } ] } } ] }

Fetches a bundle of DiagnosticReport resources based on query parameters.

API URL:

GET /DiagnosticReport

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

category string optional

Category of the diagnostic report.

Refer US Core DiagnosticReport Category and Diagnostic Service Section for LOINC codes. Accepted values: LP29684-5 | LP29708-2 | LP7839-6 | LAB

code string optional

The test, panel, report, or note that was ordered.

Include codes from SNOMED list.

date string optional

Datetime when the report or note was written.

Refer link for input format.

status string optional

The status of the diagnostic report.

Accepted values: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get DiagnosticReport By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/DiagnosticReport/1036765000000106397-IMG -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "DiagnosticReport", "id": "1036765000000106397-IMG", "meta": { "lastUpdated": "2022-11-02T02:05:10.251-07:00" }, "status": "final", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LP29684-5", "display": "Radiology" } ], "text": "Radiology" } ], "code": { "coding": [ { "system": "http://loinc.org", "display": "NECK AP& LATERAL VIEW" } ], "text": "NECK AP& LATERAL VIEW" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "effectiveDateTime": "2022-11-02T02:05:10-07:00", "issued": "2022-11-02T02:05:10.000-07:00", "performer": [ { "reference": "Practitioner/1036765000000021021", "display": "Albert Davis" } ], "result": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "unknown" } ] } ], "presentedForm": [ { "contentType": "text/plain", "data": "UXVlc3Rpb24gb2YgNG1tIGtpZG5leSBzdG9uZSwgbm9uLW9ic3RydWN0aW5nLCBubyBnYWxsIHN0b25lcywgbm8gY2hhbmdlcyBpbiBsaXZlci4K", "url": "https://www.charmhealth.com" } ] }

Fetches a specific DiagnosticReport resource.

API URL:

GET /DiagnosticReport/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the diagnostic report.

Search DiagnosticReport

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/DiagnosticReport/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","category": "LP29684-5"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "ee325ce3-1715-419d-b51b-74a5d0d7c6fa", "meta": { "lastUpdated": "2022-11-13T22:36:25.399-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DiagnosticReport/_search?patient=1036765000000056009&category=LP29684-5" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DiagnosticReport/1036765000000106397-IMG", "resource": { "resourceType": "DiagnosticReport", "id": "1036765000000106397-IMG", "meta": { "lastUpdated": "2022-11-02T02:05:10.251-07:00" }, "status": "final", "category": [ { "coding": [ { "system": "http://loinc.org", "code": "LP29684-5", "display": "Radiology" } ], "text": "Radiology" } ], "code": { "coding": [ { "system": "http://loinc.org", "display": "NECK AP& LATERAL VIEW" } ], "text": "NECK AP& LATERAL VIEW" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "effectiveDateTime": "2022-11-02T02:05:10-07:00", "issued": "2022-11-02T02:05:10.000-07:00", "performer": [ { "reference": "Practitioner/1036765000000021021", "display": "Albert Davis" } ], "result": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "unknown" } ] } ], "presentedForm": [ { "contentType": "text/plain", "data": "UXVlc3Rpb24gb2YgNG1tIGtpZG5leSBzdG9uZSwgbm9uLW9ic3RydWN0aW5nLCBubyBnYWxsIHN0b25lcywgbm8gY2hhbmdlcyBpbiBsaXZlci4K", "url": "https://www.charmhealth.com" } ] } } ] }

Fetches a bundle of DiagnosticReport resources based on query parameters.

API URL:

POST /DiagnosticReport/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

category string optional

Category of the diagnostic report.

Refer US Core DiagnosticReport Category and Diagnostic Service Section for LOINC codes. Accepted values: LP29684-5 | LP29708-2 | LP7839-6 | LAB

code string optional

The test, panel, report, or note that was ordered.

Include codes from SNOMED list.

date string optional

Datetime when the report or note was written.

Refer link for input format.

status string optional

The status of the diagnostic report.

Accepted values: registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | unknown

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

DocumentReference


        

Use these apis to fetch the Discharge summary (Diet Notes, Lifestyle Notes and Instructions), Consult note (Referral Notes), History and physical note (Patient History and Physical Examination), Progress note and Procedure note recorded for patients.

These apis are in conformance to the US Core DocumentReference Profile

List DocumentReference

Request Example

    
curl -X GET /api/ehr/v2/fhir/DocumentReference?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "2fad5e41-4146-46bc-8fd0-5d634d7c3ceb", "meta": { "lastUpdated": "2022-11-13T22:36:42.867-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DocumentReference?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DocumentReference/1036765000000102015-DS", "resource": { "resourceType": "DocumentReference", "id": "1036765000000102015-DS", "meta": { "lastUpdated": "2022-11-02T01:59:39.896-07:00" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000102015-DS" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "18842-5", "display": "Discharge summary" } ], "text": "Discharge summary" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/1036765000000056009" }, "date": "2022-11-01T08:00:00.000-07:00", "author": [ { "reference": "Practitioner/1036765000000021021" } ], "authenticator": { "reference": "Practitioner/1036765000000021021" }, "custodian": { "reference": "Organization/1036765000000021089" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "Tm92IDAxLCAyMDIyCgpMSUZFU1RZTEUgTk9URVM6IAoKQWR2aXNlIDoKRWF0IGZpYnJlIHJpY2ggZGlldHxUbyBkcmluayBwbGVudHkgb2Ygd2F0ZXJ8U0lUWiBCQVRIIGZvciBuZXh0IDIgd2Vla3MKRXhwb3N1cmUgdG8gc3VubGlnaHQKUGh5c2ljYWwgYWN0aXZpdHkgb3IgZXhwb3N1cmUgdG8gc3VubGlnaHR8Q2F1dGlvbiBhZ2FpbnN0IGZhbGwgYWR2aXNlZC4KSG9tZSBxdWFyYW50aW5lIGZvciBuZXh0IDIgd2Vla3N8UHVsc2Ugb3hpbWV0cnkgbW9uaXRvcmluZyA0dGggaG91cmx5fFRvIGFkbWl0IGluIGhvc3BpdGFsIGlmIFNwTzIgbGV2ZWwgaXMgbGVzcyB0aGFuIDk1JQoKClBBVElFTlQgSU5TVFJVQ1RJT05TOiAKClRFU1QgQURWSUNFRCA6CkNvbXBsZXRlIEJsb29kIENvdW50LCBFU1IsIENSUCwgUkJTLCBIYkExYywgU2VydW0gQ3JlYXRpbmluZSxVcmluZSBSb3V0aW5lIEFuYWx5c2lzLFVyaW5lIEN1bHR1cmUgYW5kIFNlbnNpdGl2aXR5LFJULVBDUiBmb3IgQ09WSUQtMTkgKCBUaHJvYXQgc3dhYiAvIE5hc2FsIHN3YWIgc2FtcGxlICkKUHVyZSBUb25lIEF1ZGlvbWV0cnkKWC1SYXkgUmlnaHQgRm9vdCB3aXRoIEFua2xlIFsgQVAgdmlldyAvIExhdGVyYWwgdmlldyBdCkZCUyxQUEJTLEhiQTFjLENvbXBsZXRlIEJsb29kIENvdW50LCBFU1IsIENSUCwgUkJTCgoK", "url": "https://www.charmhealth.com" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/1036765000000102015" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "sourcePatientInfo": { "reference": "Patient/1036765000000056009" } } } } ] }

Fetches a bundle of DocumentReference resources based on query parameters.

API URL:

GET /DocumentReference

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

type string optional

Kind of document.

Refer US Core Clinical Note Type for LOINC codes. Accepted values are listed below:
Code Description
10154-3 Chief complaint Narrative - Reported
10190-7 Mental status Narrative
11488-4 Consult note
11502-2 Laboratory report
11506-3 Progress note
18748-4 Diagnostic imaging study
18841-7 Hospital consultations Document
18842-5 Discharge summary
28570-0 Procedure note
34117-2 History and physical note
34746-8 Nurse Note
51847-2 Assessment and Plan note
54522-8 Functional status
55188-7 Patient Document
57133-1 Referral note
61150-9 Subjective Narrative
75310-3 Health concerns Document

date string optional

Date when the document reference was created.

Refer link for input format.

period string optional

The time period over which the service that is described by the document was provided.

Refer link for input format.

status string optional

The status of the document reference.

Accepted values: current | superseded | entered-in-error

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get DocumentReference By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/DocumentReference/1036765000000102015-DS -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "48154eb7-7b9c-49e3-8794-0a40176767eb", "meta": { "lastUpdated": "2022-11-13T22:36:44.429-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DocumentReference?_id=1036765000000102015-DS" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DocumentReference/1036765000000102015-DS", "resource": { "resourceType": "DocumentReference", "id": "1036765000000102015-DS", "meta": { "lastUpdated": "2022-11-02T01:59:39.896-07:00" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000102015-DS" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "18842-5", "display": "Discharge summary" } ], "text": "Discharge summary" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/1036765000000056009" }, "date": "2022-11-01T08:00:00.000-07:00", "author": [ { "reference": "Practitioner/1036765000000021021" } ], "authenticator": { "reference": "Practitioner/1036765000000021021" }, "custodian": { "reference": "Organization/1036765000000021089" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "Tm92IDAxLCAyMDIyCgpMSUZFU1RZTEUgTk9URVM6IAoKQWR2aXNlIDoKRWF0IGZpYnJlIHJpY2ggZGlldHxUbyBkcmluayBwbGVudHkgb2Ygd2F0ZXJ8U0lUWiBCQVRIIGZvciBuZXh0IDIgd2Vla3MKRXhwb3N1cmUgdG8gc3VubGlnaHQKUGh5c2ljYWwgYWN0aXZpdHkgb3IgZXhwb3N1cmUgdG8gc3VubGlnaHR8Q2F1dGlvbiBhZ2FpbnN0IGZhbGwgYWR2aXNlZC4KSG9tZSBxdWFyYW50aW5lIGZvciBuZXh0IDIgd2Vla3N8UHVsc2Ugb3hpbWV0cnkgbW9uaXRvcmluZyA0dGggaG91cmx5fFRvIGFkbWl0IGluIGhvc3BpdGFsIGlmIFNwTzIgbGV2ZWwgaXMgbGVzcyB0aGFuIDk1JQoKClBBVElFTlQgSU5TVFJVQ1RJT05TOiAKClRFU1QgQURWSUNFRCA6CkNvbXBsZXRlIEJsb29kIENvdW50LCBFU1IsIENSUCwgUkJTLCBIYkExYywgU2VydW0gQ3JlYXRpbmluZSxVcmluZSBSb3V0aW5lIEFuYWx5c2lzLFVyaW5lIEN1bHR1cmUgYW5kIFNlbnNpdGl2aXR5LFJULVBDUiBmb3IgQ09WSUQtMTkgKCBUaHJvYXQgc3dhYiAvIE5hc2FsIHN3YWIgc2FtcGxlICkKUHVyZSBUb25lIEF1ZGlvbWV0cnkKWC1SYXkgUmlnaHQgRm9vdCB3aXRoIEFua2xlIFsgQVAgdmlldyAvIExhdGVyYWwgdmlldyBdCkZCUyxQUEJTLEhiQTFjLENvbXBsZXRlIEJsb29kIENvdW50LCBFU1IsIENSUCwgUkJTCgoK", "url": "https://www.charmhealth.com" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/1036765000000102015" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "sourcePatientInfo": { "reference": "Patient/1036765000000056009" } } } } ] }

Fetches a specific DocumentReference resource.

API URL:

GET /DocumentReference/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the document reference.

Search DocumentReference

Request Example

    
curl -X POST /api/ehr/v2/fhir/DocumentReference/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","category": "clinical-note","type": "18842-5"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "be9b67e3-daf7-494a-b181-9bf3e275128e", "meta": { "lastUpdated": "2022-11-13T22:36:43.328-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DocumentReference/_search?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/DocumentReference/1036765000000102015-DS", "resource": { "resourceType": "DocumentReference", "id": "1036765000000102015-DS", "meta": { "lastUpdated": "2022-11-02T01:59:39.896-07:00" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000102015-DS" } ], "status": "current", "type": { "coding": [ { "system": "http://loinc.org", "code": "18842-5", "display": "Discharge summary" } ], "text": "Discharge summary" }, "category": [ { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category", "code": "clinical-note", "display": "Clinical Note" } ], "text": "Clinical Note" } ], "subject": { "reference": "Patient/1036765000000056009" }, "date": "2022-11-01T08:00:00.000-07:00", "author": [ { "reference": "Practitioner/1036765000000021021" } ], "authenticator": { "reference": "Practitioner/1036765000000021021" }, "custodian": { "reference": "Organization/1036765000000021089" }, "content": [ { "attachment": { "contentType": "text/plain", "data": "Tm92IDAxLCAyMDIyCgpMSUZFU1RZTEUgTk9URVM6IAoKQWR2aXNlIDoKRWF0IGZpYnJlIHJpY2ggZGlldHxUbyBkcmluayBwbGVudHkgb2Ygd2F0ZXJ8U0lUWiBCQVRIIGZvciBuZXh0IDIgd2Vla3MKRXhwb3N1cmUgdG8gc3VubGlnaHQKUGh5c2ljYWwgYWN0aXZpdHkgb3IgZXhwb3N1cmUgdG8gc3VubGlnaHR8Q2F1dGlvbiBhZ2FpbnN0IGZhbGwgYWR2aXNlZC4KSG9tZSBxdWFyYW50aW5lIGZvciBuZXh0IDIgd2Vla3N8UHVsc2Ugb3hpbWV0cnkgbW9uaXRvcmluZyA0dGggaG91cmx5fFRvIGFkbWl0IGluIGhvc3BpdGFsIGlmIFNwTzIgbGV2ZWwgaXMgbGVzcyB0aGFuIDk1JQoKClBBVElFTlQgSU5TVFJVQ1RJT05TOiAKClRFU1QgQURWSUNFRCA6CkNvbXBsZXRlIEJsb29kIENvdW50LCBFU1IsIENSUCwgUkJTLCBIYkExYywgU2VydW0gQ3JlYXRpbmluZSxVcmluZSBSb3V0aW5lIEFuYWx5c2lzLFVyaW5lIEN1bHR1cmUgYW5kIFNlbnNpdGl2aXR5LFJULVBDUiBmb3IgQ09WSUQtMTkgKCBUaHJvYXQgc3dhYiAvIE5hc2FsIHN3YWIgc2FtcGxlICkKUHVyZSBUb25lIEF1ZGlvbWV0cnkKWC1SYXkgUmlnaHQgRm9vdCB3aXRoIEFua2xlIFsgQVAgdmlldyAvIExhdGVyYWwgdmlldyBdCkZCUyxQUEJTLEhiQTFjLENvbXBsZXRlIEJsb29kIENvdW50LCBFU1IsIENSUCwgUkJTCgoK", "url": "https://www.charmhealth.com" }, "format": { "system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem", "code": "urn:ihe:iti:xds:2017:mimeTypeSufficient", "display": "mimeType Sufficient" } } ], "context": { "encounter": [ { "reference": "Encounter/1036765000000102015" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "sourcePatientInfo": { "reference": "Patient/1036765000000056009" } } } } ] }

Fetches a bundle of DocumentReference resources based on query parameters.

API URL:

POST /DocumentReference/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

type string optional

Kind of document.

Refer US Core Clinical Note Type for LOINC codes. Accepted values are listed below:
Code Description
10154-3 Chief complaint Narrative - Reported
10190-7 Mental status Narrative
11488-4 Consult note
11502-2 Laboratory report
11506-3 Progress note
18748-4 Diagnostic imaging study
18841-7 Hospital consultations Document
18842-5 Discharge summary
28570-0 Procedure note
34117-2 History and physical note
34746-8 Nurse Note
51847-2 Assessment and Plan note
54522-8 Functional status
55188-7 Patient Document
57133-1 Referral note
61150-9 Subjective Narrative
75310-3 Health concerns Document

date string optional

Date when the document reference was created.

Refer link for input format.

period string optional

The time period over which the service that is described by the document was provided.

Refer link for input format.

status string optional

The status of the document reference.

Accepted values: current | superseded | entered-in-error

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Encounter


        

Use these apis to fetch the Encounter data recorded for patients.

These apis are in conformance to the US Core Encounter Profile

List Encounter

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Encounter?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "4b8db254-0d84-4528-b793-04f5ef6524dd", "meta": { "lastUpdated": "2022-09-23T13:08:11.024+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Encounter?patient=Patient/1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Encounter/1036765000000102015", "resource": { "resourceType": "Encounter", "id": "1036765000000102015", "meta": { "lastUpdated": "2022-11-02T01:59:39.896-07:00" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000102015" } ], "status": "finished", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "AMB", "display": "ambulatory" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453701000124103", "display": "In-person encounter" } ], "text": "In-person encounter" } ], "subject": { "reference": "Patient/1036765000000056009" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "CON", "display": "consultant" } ], "text": "consultant" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "individual": { "reference": "Practitioner/1036765000000021021" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "CON", "display": "consultant" } ], "text": "consultant" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "individual": { "reference": "Practitioner/1036765000000021021" } } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "reasonCode": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "unknown", "display": "Unknown" } ] } ], "hospitalization": { "dischargeDisposition": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "unsupported", "display": "Unsupported" } ] } }, "location": [ { "location": { "reference": "Location/1036765000000021089" } } ] } } ] }

Fetches a bundle of Encounter resources based on query parameters.

API URL:

GET /Encounter

QUERY PARAMETERS:

Name Type Required Description
_id long optional Encounter Identifier
identifier string optional

Encounter Reference.

Refer Identifer for input format.

patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

The status of the encounter.

Accepted values: planned | arrived | triaged | in-progress | onleave | finished | cancelled

class string optional

Classification of patient encounter.

Refer ActEncounterCode. Accepted values: AMB | EMER | FLD | HH | IMP | ACUTE | NONAC | OBSENC | PRENC | SS | VR

type string optional

Specific type of encounter.

Refer US Core Encounter Type for LOINC codes

date string optional

Date of the encounter.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Encounter By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Encounter/1036765000000102015 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Encounter", "id": "1036765000000102015", "meta": { "lastUpdated": "2022-11-02T01:59:39.896-07:00" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000102015" } ], "status": "finished", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "AMB", "display": "ambulatory" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453701000124103", "display": "In-person encounter" } ], "text": "In-person encounter" } ], "subject": { "reference": "Patient/1036765000000056009" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "CON", "display": "consultant" } ], "text": "consultant" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "individual": { "reference": "Practitioner/1036765000000021021" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "CON", "display": "consultant" } ], "text": "consultant" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "individual": { "reference": "Practitioner/1036765000000021021" } } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "reasonCode": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "unknown", "display": "Unknown" } ] } ], "hospitalization": { "dischargeDisposition": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "unsupported", "display": "Unsupported" } ] } }, "location": [ { "location": { "reference": "Location/1036765000000021089" } } ] }

Fetches a specific Encounter resource.

API URL:

GET /Encounter/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the encounter.

Search Encounter

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Encounter/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","status": "finished","date": "gt2022-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "4b8db254-0d84-4528-b793-04f5ef6524dd", "meta": { "lastUpdated": "2022-09-23T13:08:11.024+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Encounter/_search" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Encounter/153", "resource": { "resourceType": "Encounter", "id": "1036765000000102015", "meta": { "lastUpdated": "2022-11-02T01:59:39.896-07:00" }, "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000102015" } ], "status": "finished", "class": { "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", "code": "AMB", "display": "ambulatory" }, "type": [ { "coding": [ { "system": "http://snomed.info/sct", "code": "453701000124103", "display": "In-person encounter" } ], "text": "In-person encounter" } ], "subject": { "reference": "Patient/1036765000000056009" }, "participant": [ { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "CON", "display": "consultant" } ], "text": "consultant" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "individual": { "reference": "Practitioner/1036765000000021021" } }, { "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType", "code": "CON", "display": "consultant" } ], "text": "consultant" } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "individual": { "reference": "Practitioner/1036765000000021021" } } ], "period": { "start": "2022-11-01T08:00:00-07:00" }, "reasonCode": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "unknown", "display": "Unknown" } ] } ], "hospitalization": { "dischargeDisposition": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/data-absent-reason", "code": "unsupported", "display": "Unsupported" } ] } }, "location": [ { "location": { "reference": "Location/1036765000000021089" } } ] } } ] }

Fetches a bundle of Encounter resources based on query parameters.

API URL:

POST /Encounter/_search

QUERY PARAMETERS:

Name Type Required Description
_id long optional Encounter Identifier
identifier string optional

Encounter Reference.

Refer Identifer for input format.

patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

status string optional

The status of the encounter.

Accepted values: planned | arrived | triaged | in-progress | onleave | finished | cancelled

class string optional

Classification of patient encounter.

Refer ActEncounterCode. Accepted values: AMB | EMER | FLD | HH | IMP | ACUTE | NONAC | OBSENC | PRENC | SS | VR

type string optional

Specific type of encounter.

Refer US Core Encounter Type for LOINC codes

date string optional

Date of the encounter.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

FamilyMemberHistory


        

Use these apis to fetch the FamilyMemberHistory data recorded for patients.

These apis are in conformance to the US Core FamilyMemberHistory Profile

List FamilyMemberHistory

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/FamilyMemberHistory?patient=Patient/100002000000006721 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "4123060f-6bd1-4c99-a2f9-971f7095a2ce", "meta": { "lastUpdated": "2023-10-31T11:55:35.265+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/FamilyMemberHistory?patient=Patient/100002000000006721" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/FamilyMemberHistory/100002000000016009", "resource": { "resourceType": "FamilyMemberHistory", "id": "100002000000016009", "identifier": [ { "system": "https://www.charmhealth.com", "value": "100002000000016009" } ], "status": "completed", "patient": { "reference": "Patient/100002000000006721" }, "relationship": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "TWINBRO", "display": "twin brother" } ], "text": "The scoper was carried in the same womb as the male player and shares common biological parents." }, "bornDate": "1998-01-01", "ageString": "25 years", "deceasedBoolean": true, "condition": [ { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "60856006", "display": "Heart failure following cardiac surgery" } ], "text": "Heart failure following cardiac surgery" } }, { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "72100002", "display": "Liver spot" } ], "text": "Liver spot" } } ] } } ] }

Fetches a bundle of FamilyMemberHistory resources based on query parameters.

API URL:

GET /FamilyMemberHistory

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

date string optional

Date of the family member history recorded.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get FamilyMemberHistory By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/FamilyMemberHistory/1036765000000102015 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "FamilyMemberHistory", "id": "100002000000016009", "identifier": [ { "system": "https://www.charmhealth.com", "value": "100002000000016009" } ], "status": "completed", "patient": { "reference": "Patient/100002000000006721" }, "relationship": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "TWINBRO", "display": "twin brother" } ], "text": "The scoper was carried in the same womb as the male player and shares common biological parents." }, "bornDate": "1998-01-01", "ageString": "25 years", "deceasedBoolean": true, "condition": [ { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "60856006", "display": "Heart failure following cardiac surgery" } ], "text": "Heart failure following cardiac surgery" } }, { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "72100002", "display": "Liver spot" } ], "text": "Liver spot" } } ] }

Fetches a specific FamilyMemberHistory resource.

API URL:

GET /FamilyMemberHistory/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the family member history.

Search FamilyMemberHistory

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/FamilyMemberHistory/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/100002000000006721","date": "gt2023-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "76c6a557-a255-4e2d-b40c-e76bf8a200dd", "meta": { "lastUpdated": "2023-10-31T11:58:29.219+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/FamilyMemberHistory/_search?patient=Patient/100002000000006721&date=gt2023-08-10T12:30:00-05:30" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/FamilyMemberHistory/100002000000016009", "resource": { "resourceType": "FamilyMemberHistory", "id": "100002000000016009", "identifier": [ { "system": "https://www.charmhealth.com", "value": "100002000000016009" } ], "status": "completed", "patient": { "reference": "Patient/100002000000006721" }, "relationship": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode", "code": "TWINBRO", "display": "twin brother" } ], "text": "The scoper was carried in the same womb as the male player and shares common biological parents." }, "bornDate": "1998-01-01", "ageString": "25 years", "deceasedBoolean": true, "condition": [ { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "60856006", "display": "Heart failure following cardiac surgery" } ], "text": "Heart failure following cardiac surgery" } }, { "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "72100002", "display": "Liver spot" } ], "text": "Liver spot" } } ] } } ] }

Fetches a bundle of FamilyMemberHistory resources based on query parameters.

API URL:

POST /FamilyMemberHistory/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

date string optional

Date of the family member history recorded.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Goal


        

Use these apis to fetch the Goal data recorded for patients.

These apis are in conformance to the US Core Goal Profile

List Goal

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Goal?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "6a989445-4acd-4abd-9927-382cd7320049", "meta": { "lastUpdated": "2022-11-13T22:36:51.173-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Goal?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Goal/1036765000000122003", "resource": { "resourceType": "Goal", "id": "1036765000000122003", "meta": { "lastUpdated": "2022-11-13T22:19:12.677-08:00" }, "lifecycleStatus": "completed", "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-priority", "code": "high-priority", "display": "High Priority" } ], "text": "Indicates that the goal is of considerable importance and should be a primary focus of care delivery." }, "description": { "text": "Patient will reduce overall level, frequency, and intensity of anxiety so that daily functioning is not impaired." }, "subject": { "reference": "Patient/1036765000000056009" }, "startDate": "2022-11-02", "target": [ { "dueDate": "2022-11-20" } ], "expressedBy": { "reference": "Practitioner/1036765000000031651" } } } ] }

Fetches a bundle of Goal resources based on query parameters.

API URL:

GET /Goal

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

lifecycle-status string optional

The state of the goal throughout its lifecycle.

Accepted values: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected

target-date string optional

Date when goal should be done.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Goal By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Goal/1036765000000122003 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Goal", "id": "1036765000000122003", "meta": { "lastUpdated": "2022-11-13T22:19:12.677-08:00" }, "lifecycleStatus": "completed", "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-priority", "code": "high-priority", "display": "High Priority" } ], "text": "Indicates that the goal is of considerable importance and should be a primary focus of care delivery." }, "description": { "text": "Patient will reduce overall level, frequency, and intensity of anxiety so that daily functioning is not impaired." }, "subject": { "reference": "Patient/1036765000000056009" }, "startDate": "2022-11-02", "target": [ { "dueDate": "2022-11-20" } ], "expressedBy": { "reference": "Practitioner/1036765000000031651" } }

Fetches a specific Goal resource.

API URL:

GET /Goal/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Goal.

Search Goal

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Goal/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","lifecycle-status": "completed","target-date": "gt2022-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "18debb72-342e-46be-8739-ad19072e9dda", "meta": { "lastUpdated": "2022-11-13T22:36:51.622-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Goal/_search?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Goal/1036765000000122003", "resource": { "resourceType": "Goal", "id": "1036765000000122003", "meta": { "lastUpdated": "2022-11-13T22:19:12.677-08:00" }, "lifecycleStatus": "completed", "priority": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/goal-priority", "code": "high-priority", "display": "High Priority" } ], "text": "Indicates that the goal is of considerable importance and should be a primary focus of care delivery." }, "description": { "text": "Patient will reduce overall level, frequency, and intensity of anxiety so that daily functioning is not impaired." }, "subject": { "reference": "Patient/1036765000000056009" }, "startDate": "2022-11-02", "target": [ { "dueDate": "2022-11-20" } ], "expressedBy": { "reference": "Practitioner/1036765000000031651" } } } ] }

Fetches a bundle of Goal resources based on query parameters.

API URL:

POST /Goal/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

lifecycle-status string optional

The state of the goal throughout its lifecycle.

Accepted values: proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected

target-date string optional

Date when goal should be done.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Immunization


        

Use these apis to fetch the Immunization data recorded for patients.

These apis are in conformance to the US Core Immunization Profile

List Immunization

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Immunization?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "a890dd71-a9b0-44bd-ae8d-5e710cc3ec81", "meta": { "lastUpdated": "2022-11-13T22:36:53.516-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Immunization?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Immunization/1036765000000116739", "resource": { "resourceType": "Immunization", "id": "1036765000000116739", "status": "not-done", "statusReason": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason", "code": "PATOBJ", "display": "patient objection" } ], "text": "patient objection" }, "vaccineCode": { "coding": [ { "system": "https://terminology.hl7.org/1.0.0//CodeSystem-CVX.html", "code": "03", "display": "MMR" } ], "text": "MMR" }, "patient": { "reference": "Patient/1036765000000056009" }, "occurrenceDateTime": "2022-11-02T00:00:00-07:00", "recorded": "2022-11-02T00:00:00-07:00", "primarySource": true, "location": { "reference": "Organization/1036765000000021089", "display": "Neighborhood Physicians Practice" } } } ] }

Fetches a bundle of Immunization resources based on query parameters.

API URL:

GET /Immunization

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

date string optional

Date when the document reference was created.

Refer link for input format.

status string optional

The status of the document reference.

Accepted values: completed | not-done | entered-in-error

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Immunization By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Immunization/1036765000000116739 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Immunization", "id": "1036765000000116739", "status": "not-done", "statusReason": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason", "code": "PATOBJ", "display": "patient objection" } ], "text": "patient objection" }, "vaccineCode": { "coding": [ { "system": "https://terminology.hl7.org/1.0.0//CodeSystem-CVX.html", "code": "03", "display": "MMR" } ], "text": "MMR" }, "patient": { "reference": "Patient/1036765000000056009" }, "occurrenceDateTime": "2022-11-02T00:00:00-07:00", "recorded": "2022-11-02T00:00:00-07:00", "primarySource": true, "location": { "reference": "Organization/1036765000000021089", "display": "Neighborhood Physicians Practice" } }

Fetches a specific Immunization resource.

API URL:

GET /Immunization/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the immunization.

Search Immunization

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Immunization/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","status": "completed","date": "gt2022-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "3e5f384a-a417-44dd-88ea-83390d642726", "meta": { "lastUpdated": "2022-11-13T22:36:53.996-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Immunization/_search?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Immunization/1036765000000102287", "resource": { "resourceType": "Immunization", "id": "1036765000000102287", "status": "completed", "vaccineCode": { "coding": [ { "system": "https://terminology.hl7.org/1.0.0//CodeSystem-CVX.html", "code": "140", "display": "Influenza, seasonal, injectable, preservative free" } ], "text": "Influenza, seasonal, injectable, preservative free" }, "patient": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "occurrenceDateTime": "2022-11-01T08:00:00-07:00", "recorded": "2022-11-01T08:00:00-07:00", "primarySource": true, "location": { "reference": "Organization/1036765000000021089", "display": "Neighborhood Physicians Practice" }, "manufacturer": { "reference": "Barr Laboratories" }, "lotNumber": "342342", "expirationDate": "2045-01-01", "site": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite", "code": "LT", "display": "Left Thigh" } ], "text": "Left Thigh" }, "route": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration", "code": "IM", "display": "Injection, intramuscular" } ], "text": "Injection, intramuscular" }, "doseQuantity": { "value": 0.5, "unit": "ml" }, "performer": [ { "actor": { "reference": "Practitioner/1036765000000021021" } } ], "programEligibility": [ { "coding": [ { "code": "V01", "display": "Not VFC eligible" } ], "text": "Not VFC eligible" } ], "fundingSource": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source", "code": "private", "display": "Private" } ], "text": "Private" } } } ] }

Fetches a bundle of Immunization resources based on query parameters.

API URL:

POST /Location/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

date string optional

Date when the document reference was created.

Refer link for input format.

status string optional

The status of the document reference.

Accepted values: completed | not-done | entered-in-error

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Location


        

Use these apis to fetch the Location data recorded for Organizations.

These apis are in conformance to the US Core Location Profile

List Location

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Location?name=Neighborhood Physicians Practice -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "86039520-cbc7-4e5b-900f-a4e408035e4c", "meta": { "lastUpdated": "2022-09-23T13:06:21.155+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Location" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Location/1036765000000021089", "resource": { "resourceType": "Location", "id": "1036765000000021089", "status": "active", "name": "Neighborhood Physicians Practice", "telecom": [ { "system": "phone", "value": "5555551002", "use": "work" } ], "address": { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton", "state": "Oregon", "postalCode": "97006", "country": "us" }, "managingOrganization": { "reference": "Organization/1036765000000021089", "display": "Neighborhood Physicians Practice" } } } ] }

Fetches a bundle of Location resources based on query parameters.

API URL:

GET /Location

QUERY PARAMETERS:

Name Type Required Description
name String optional Name of the location
address string optional Address of the location
address-city string optional City of the location
address-state string optional State of the location
address-postalcode string optional Postal code of the location
page integer optional Page Number of the list

Get Location By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Location/1036765000000021089 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Location", "id": "1036765000000021089", "status": "active", "name": "Neighborhood Physicians Practice", "telecom": [ { "system": "phone", "value": "5555551002", "use": "work" } ], "address": { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton", "state": "Oregon", "postalCode": "97006", "country": "us" }, "managingOrganization": { "reference": "Organization/1036765000000021089", "display": "Neighborhood Physicians Practice" } }

Fetches a specific Location resource.

API URL:

GET /Location/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Location.

Search Location

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/Location/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"name": "Neighborhood Physicians Practice","address-postalcode": "23111"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "4b8db254-0d84-4528-b793-04f5ef6524dd", "meta": { "lastUpdated": "2022-09-23T13:08:11.024+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Location/_search" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Location/1036765000000021089", "resource": { "resourceType": "Location", "id": "1036765000000021089", "status": "active", "name": "Neighborhood Physicians Practice", "telecom": [ { "system": "phone", "value": "5555551002", "use": "work" } ], "address": { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton", "state": "Oregon", "postalCode": "97006", "country": "us" }, "managingOrganization": { "reference": "Organization/1036765000000021089", "display": "Neighborhood Physicians Practice" } } } ] }

Fetches a bundle of Location resources based on query parameters.

API URL:

POST /Location/_search

QUERY PARAMETERS:

Name Type Required Description
name String optional Name of the location
address string optional Address of the location
address-city string optional City of the location
address-state string optional State of the location
address-postalcode string optional Postal code of the location
page integer optional Page Number of the list

MedicationAdministration


        

Use these apis to fetch the MedicationAdministration data recorded for patients.

These apis are in conformance to the US Core MedicationAdministration Profile

List MedicationAdministration

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/MedicationAdministration?patient=Patient/100001000000015007 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "ef28f095-ebb4-457b-b394-3333d2c43366", "meta": { "lastUpdated": "2023-10-31T15:47:25.296+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationAdministration?patient=Patient/100001000000015007" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationAdministration/100001000000016079", "resource": { "resourceType": "MedicationAdministration", "id": "100001000000016079", "status": "completed", "category": { "coding": [ { "system": "http://hl7.org/fhir/medication-admin-category", "code": "outpatient", "display": "Outpatient" } ], "text": "Includes administrations in an outpatient setting (for example, Emergency Department, Outpatient Clinic, Outpatient Surgery, Doctor's office)" }, "medicationCodeableConcept": { "coding": [ { "display": "Insulin" } ], "text": "Insulin" }, "subject": { "reference": "Patient/100001000000015007" }, "context": { "reference": "Encounter/100001000000016067" }, "effectiveDateTime": "2023-10-31T00:09:00+05:30", "performer": [ { "actor": { "reference": "Practitioner/100001000000000109" } } ], "dosage": { "text": "1.0 ml Once 1 days Intramuscular Right Deltoid", "site": { "coding": [ { "display": "Right Deltoid" } ], "text": "Right Deltoid" }, "route": { "coding": [ { "display": "Intramuscular" } ], "text": "Intramuscular" }, "dose": { "value": 1, "unit": "ml" } } } } ] }

Fetches a bundle of MedicationAdministration resources based on query parameters.

API URL:

GET /MedicationAdministration

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

status string optional

The status of the medication administration.

Accepted values: in-progress | completed

date string optional

Date of the medication administration.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get MedicationAdministration By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/MedicationAdministration/100001000000016079 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "MedicationAdministration", "id": "100001000000016079", "status": "completed", "category": { "coding": [ { "system": "http://hl7.org/fhir/medication-admin-category", "code": "outpatient", "display": "Outpatient" } ], "text": "Includes administrations in an outpatient setting (for example, Emergency Department, Outpatient Clinic, Outpatient Surgery, Doctor's office)" }, "medicationCodeableConcept": { "coding": [ { "display": "Insulin" } ], "text": "Insulin" }, "subject": { "reference": "Patient/100001000000015007" }, "context": { "reference": "Encounter/100001000000016067" }, "effectiveDateTime": "2023-10-31T00:09:00+05:30", "performer": [ { "actor": { "reference": "Practitioner/100001000000000109" } } ], "dosage": { "text": "1.0 ml Once 1 days Intramuscular Right Deltoid", "site": { "coding": [ { "display": "Right Deltoid" } ], "text": "Right Deltoid" }, "route": { "coding": [ { "display": "Intramuscular" } ], "text": "Intramuscular" }, "dose": { "value": 1, "unit": "ml" } } }

Fetches a specific MedicationAdministration resource.

API URL:

GET /MedicationAdministration/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the medicationadministration.

Search MedicationAdministration

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/MedicationAdministration/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/100001000000015007","date": "gt2023-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "ef28f095-ebb4-457b-b394-3333d2c43366", "meta": { "lastUpdated": "2023-10-31T15:47:25.296+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationAdministration?patient=Patient/100001000000015007&date=gt2023-08-10T12:30:00-05:30" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationAdministration/100001000000016079", "resource": { "resourceType": "MedicationAdministration", "id": "100001000000016079", "status": "completed", "category": { "coding": [ { "system": "http://hl7.org/fhir/medication-admin-category", "code": "outpatient", "display": "Outpatient" } ], "text": "Includes administrations in an outpatient setting (for example, Emergency Department, Outpatient Clinic, Outpatient Surgery, Doctor's office)" }, "medicationCodeableConcept": { "coding": [ { "display": "Insulin" } ], "text": "Insulin" }, "subject": { "reference": "Patient/100001000000015007" }, "context": { "reference": "Encounter/100001000000016067" }, "effectiveDateTime": "2023-10-31T00:09:00+05:30", "performer": [ { "actor": { "reference": "Practitioner/100001000000000109" } } ], "dosage": { "text": "1.0 ml Once 1 days Intramuscular Right Deltoid", "site": { "coding": [ { "display": "Right Deltoid" } ], "text": "Right Deltoid" }, "route": { "coding": [ { "display": "Intramuscular" } ], "text": "Intramuscular" }, "dose": { "value": 1, "unit": "ml" } } } } ] }

Fetches a bundle of MedicationAdministration resources based on query parameters.

API URL:

POST /MedicationAdministration/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

status string optional

The status of the medication administration.

Accepted values: in-progress | completed

date string optional

Date of the medication administration.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

MedicationRequest


        

Use these apis to fetch the MedicationRequest data recorded for patients.

These apis are in conformance to the US Core MedicationRequest Profile

List MedicationRequest

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/MedicationRequest?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "ade6be83-c999-4ed1-8533-37d98c39f87a", "meta": { "lastUpdated": "2022-11-13T22:37:01.421-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationRequest?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationRequest/1036765000000106501", "resource": { "resourceType": "MedicationRequest", "id": "1036765000000106501", "meta": { "lastUpdated": "2022-11-02T02:13:39.007-07:00" }, "status": "active", "intent": "order", "reportedReference": { "reference": "Practitioner/1036765000000021021" }, "medicationReference": { "reference": "Medication/1036765000000106499" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102063" }, "authoredOn": "2022-11-02T00:00:00-07:00", "requester": { "reference": "Practitioner/1036765000000021021" }, "dosageInstruction": [ { "text": "2 capsule(s) once a month in the evening for 2 Month(s), intravenous route", "route": { "text": "intravenous" } } ] } } ] }

Fetches a bundle of MedicationRequest resources based on query parameters.

API URL:

GET /MedicationRequest

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

encounter string optional

Encounter Reference.

Refer Identifer for input format.

intent string optional

Whether the request is a proposal, plan, or an original order.

Accepted values: proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

authoredon string optional

The date (and perhaps time) when the prescription was initially written or authored on.

Refer link for input format.

status string optional

The current state of the order.

Accepted values: active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown

_include string optional

Includes subject resources in the resource.

Accepted value: MedicationRequest:medication

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get MedicationRequest By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/MedicationRequest/1036765000000106237 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "MedicationRequest", "id": "1036765000000106237", "meta": { "lastUpdated": "2022-11-02T01:59:39.977-07:00" }, "status": "active", "intent": "order", "reportedReference": { "reference": "Practitioner/1036765000000021021" }, "medicationReference": { "reference": "Medication/1036765000000101023" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "authoredOn": "2022-11-02T00:00:00-07:00", "requester": { "reference": "Practitioner/1036765000000021021" }, "dosageInstruction": [ { "text": "1 ml 2 times a day in the morning for 2 Day(s), mucous membrane route", "route": { "text": "mucous membrane" } } ] }

Fetches a specific MedicationRequest resource.

API URL:

GET /MedicationRequest/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Medication request.

Search MedicationRequest

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/MedicationRequest/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","intent": "order","status": "active"}

Response Example

HTTP/1.1 201 Created { "resourceType": "Bundle", "id": "1b7affb9-d2a1-4a80-8fb8-ce0633fd3565", "meta": { "lastUpdated": "2022-11-13T22:36:57.294-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationRequest/_search?patient=1036765000000056009&intent=order" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/MedicationRequest/1036765000000106501", "resource": { "resourceType": "MedicationRequest", "id": "1036765000000106501", "meta": { "lastUpdated": "2022-11-02T02:13:39.007-07:00" }, "status": "active", "intent": "order", "reportedReference": { "reference": "Practitioner/1036765000000021021" }, "medicationReference": { "reference": "Medication/1036765000000106499" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102063" }, "authoredOn": "2022-11-02T00:00:00-07:00", "requester": { "reference": "Practitioner/1036765000000021021" }, "dosageInstruction": [ { "text": "2 capsule(s) once a month in the evening for 2 Month(s), intravenous route", "route": { "text": "intravenous" } } ] } } ] }

Fetches a bundle of MedicationRequest resources based on query parameters.

API URL:

POST /MedicationRequest/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

encounter string optional

Encounter Reference.

Refer Identifer for input format.

intent string optional

Whether the request is a proposal, plan, or an original order.

Accepted values: proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

authoredon string optional

The date (and perhaps time) when the prescription was initially written or authored on.

Refer link for input format.

status string optional

The current state of the order.

Accepted values: active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown

_include string optional

Includes subject resources in the resource.

Accepted value: MedicationRequest:medication

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Medication


        

Use these apis to fetch the Medication data.

These apis are in conformance to the US Core Medication Profile

Get Medication By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/Medication/1036765000000106499 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Medication", "id": "1036765000000106499", "code": { "coding": [ { "system": "http://www.nlm.nih.gov/research/umls/rxnorm", "code": "2374558", "display": "eravacycline 100 mg intravenous injection" } ], "text": "eravacycline 100 mg intravenous injection" }, "status": "active", "form": { "text": "powder for injection" } }

Fetches a specific Medication resource.

API URL:

GET /Medication/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Medication.

Observation


        

Use these apis to fetch the Vitals, Smoking Status and Lab Results recorded for patients.

These apis are in conformance to the US Core profiles below.

List Observation

Request Example

    
curl -X GET /api/ehr/v2/fhir/Observation?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "9165be71-6506-45ec-89f9-3a9b48594347", "meta": { "lastUpdated": "2022-11-13T22:37:15.017-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Observation?category=patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Observation/1036765000000102239-bp", "resource": { "resourceType": "Observation", "id": "1036765000000102239-bp", "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs", "display": "Vital Signs" } ], "text": "Clinical observations measure the body's basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area." } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "85354-9", "display": "Blood Pressure" } ], "text": "Blood Pressure" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "effectiveDateTime": "2022-11-01T08:00:00-07:00", "performer": [ { "reference": "Practitioner/1036765000000021021" } ], "component": [ { "code": { "coding": [ { "system": "http://loinc.org", "code": "8462-4", "display": "Diastolic Blood Pressure" } ], "text": "Diastolic Blood Pressure" }, "valueQuantity": { "value": 80, "unit": "mm[Hg]", "system": "http://unitsofmeasure.org", "code": "mm[Hg]" } }, { "code": { "coding": [ { "system": "http://loinc.org", "code": "8480-6", "display": "Systolic Blood Pressure" } ], "text": "Systolic Blood Pressure" }, "valueQuantity": { "value": 120, "unit": "mm[Hg]", "system": "http://unitsofmeasure.org", "code": "mm[Hg]" } } ] } } ] }

Fetches a bundle of Observation resources based on query parameters.

API URL:

GET /Observation

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

code string optional

Code of what was observed.

Include codes from SNOMED list.

category string optional

A code that classifies the general type of observation being made.

Accepted values: survey | vital-signs | laboratory | social-history

date string optional

The date and time this version of the observation was made.

Refer link for input format.

status string optional

The status of the result value.

Accepted values: registered | preliminary | final | amended | corrected | cancelled | entered-in-error | unknown | pending | deprecated

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Observation By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/Observation/1036765000000102239-wfh -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Observation", "id": "1036765000000102239-wfh", "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs", "display": "Vital Signs" } ], "text": "Clinical observations measure the body's basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area." } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "77606-2", "display": "Weight for Height Percentile" } ], "text": "Weight for Height Percentile" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "effectiveDateTime": "2022-11-01T08:00:00-07:00", "performer": [ { "reference": "Practitioner/1036765000000021021" } ], "valueQuantity": { "value": 17, "unit": "%", "system": "http://unitsofmeasure.org", "code": "%" } }

Fetches a specific Observation resource.

API URL:

GET /Observation/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Observation.

Search Observation

Request Example

    
curl -X POST /api/ehr/v2/fhir/Observation/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/1036765000000056009","code": "77606-2","category": "vital-signs"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "5bb71076-c07f-48b1-b297-ed7a32f42b24", "meta": { "lastUpdated": "2022-11-13T22:37:10.193-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Observation/_search?patient=1036765000000056009&code=77606-2&category=vital-signs" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Observation/1036765000000102239-wfh", "resource": { "resourceType": "Observation", "id": "1036765000000102239-wfh", "status": "final", "category": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/observation-category", "code": "vital-signs", "display": "Vital Signs" } ], "text": "Clinical observations measure the body's basic functions such as blood pressure, heart rate, respiratory rate, height, weight, body mass index, head circumference, pulse oximetry, temperature, and body surface area." } ], "code": { "coding": [ { "system": "http://loinc.org", "code": "77606-2", "display": "Weight for Height Percentile" } ], "text": "Weight for Height Percentile" }, "subject": { "reference": "Patient/1036765000000056009" }, "encounter": { "reference": "Encounter/1036765000000102015" }, "effectiveDateTime": "2022-11-01T08:00:00-07:00", "performer": [ { "reference": "Practitioner/1036765000000021021" } ], "valueQuantity": { "value": 7.519199848175049, "unit": "%", "system": "http://unitsofmeasure.org", "code": "%" } } } ] }

Fetches a bundle of Observation resources based on query parameters.

API URL:

POST /Observation/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

code string optional

Code of what was observed.

Include codes from SNOMED list.

category string optional

A code that classifies the general type of observation being made.

Accepted values: survey | vital-signs | laboratory | social-history

date string optional

The date and time this version of the observation was made.

Refer link for input format.

status string optional

The status of the result value.

Accepted values: registered | preliminary | final | amended | corrected | cancelled | entered-in-error | unknown | pending | deprecated

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Organization


        

Use these apis to fetch the Organization data.

These apis are in conformance to the US Core Organization Profile

List Organization

Request Example

    
curl -X GET /api/ehr/v2/fhir/Organization?name=Neighborhood Physicians Practice -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "86039520-cbc7-4e5b-900f-a4e408035e4c", "meta": { "lastUpdated": "2022-09-23T13:06:21.155+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Organization" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Organization/1036765000000021089", "resource": { "resourceType": "Organization", "id": "100001000000000161", "status": "active", "name": "Big Bang Theory", "address": { "use": "work", "line": [ "13 Rue Street" ], "city": "Eugene", "state": "Florida", "postalCode": "23111-3222", "country": "us" }, "managingOrganization": { "reference": "Organization/100001000000000161", "display": "Big Bang Theory" } } } ] }

Fetches a bundle of Organization resources based on query parameters.

API URL:

GET /Organization

QUERY PARAMETERS:

Name Type Required Description
name String optional Name of the organization
address string optional Address of the organization
page integer optional Page Number of the list

Get Organization By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/Organization/1036765000000021089 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Organization", "id": "1036765000000021089", "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000021089" }, { "system": "http://hl7.org/fhir/sid/us-npi", "value": "1122334455" } ], "active": true, "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/organization-type", "code": "prov", "display": "Healthcare Provider" } ], "text": "An organization that provides healthcare services." } ], "name": "Neighborhood Physicians Practice", "telecom": [ { "system": "phone", "value": "5555551002", "use": "work" } ], "address": [ { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton", "state": "Oregon", "postalCode": "97006", "country": "us" } ], "contact": [ { "name": { "given": [ "Tracy Davis" ] } } ] }

Fetches a specific Organization resource.

API URL:

GET /Organization/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Care Plan.

Search Organization

Request Example

    
curl -X POST /api/ehr/v2/fhir/Organization/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"name": "Neighborhood Physicians Practice"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "4b8db254-0d84-4528-b793-04f5ef6524dd", "meta": { "lastUpdated": "2022-09-23T13:08:11.024+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Organization/_search" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Organization/1036765000000021089", "resource": { "resourceType": "Organization", "id": "1036765000000021089", "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000021089" }, { "system": "http://hl7.org/fhir/sid/us-npi", "value": "1122334455" } ], "active": true, "type": [ { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/organization-type", "code": "prov", "display": "Healthcare Provider" } ], "text": "An organization that provides healthcare services." } ], "name": "Neighborhood Physicians Practice", "telecom": [ { "system": "phone", "value": "5555551002", "use": "work" } ], "address": [ { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton", "state": "Oregon", "postalCode": "97006", "country": "us" } ], "contact": [ { "name": { "given": [ "Tracy Davis" ] } } ] } } ] }

Fetches a bundle of Organization resources based on query parameters.

API URL:

POST /Organization/_search

QUERY PARAMETERS:

Name Type Required Description
name String optional Name of the organization
address string optional Address of the organization
page integer optional Page Number of the list

Patient


        

Use these apis to fetch the Demographics data recorded for patients.

These apis are in conformance to the US Core Patient Profile

List Patient

Request Example

    
curl -X GET /api/ehr/v2/fhir/Patient?_id=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "3d27eaef-fb1b-44fe-afd3-25b7b683a825", "meta": { "lastUpdated": "2022-11-13T22:36:01.099-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Patient?_id=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Patient/1036765000000056009", "resource": { "resourceType": "Patient", "id": "1036765000000056009", "meta": { "lastUpdated": "2022-11-02T03:00:20.899-07:00" }, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode": "M" }, { "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-race", "extension": [ { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1002-5", "display": "American Indian Or Alaska Native" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1490-2", "display": "Acoma" } }, { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2106-3", "display": "White" } }, { "url": "text", "valueString": "Mixed" } ] } ], "identifier": [ { "system": "https://www.charmhealth.com", "value": "PAT0005" } ], "active": true, "name": [ { "use": "official", "text": "Roger Federer", "family": "Federer", "given": [ "Roger" ] } ], "telecom": [ { "system": "phone", "value": "5557702787", "use": "home" }, { "system": "email", "value": "roger222@gmail.com" } ], "gender": "male", "birthDate": "1940-09-05", "address": [ { "use": "home", "line": [ "599 Schowalter Promenade" ], "city": "West Springfield", "state": "MA", "postalCode": "01089", "country": "us", "period": { "start": "2022-10-14T05:35:41-07:00" } } ], "maritalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "M", "display": "Married" } ], "text": "A current marriage contract is active" }, "communication": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en", "display": "English" } ], "text": "The language which can be used to communicate with the patient about his or her health" } } ] } } ] }

Fetches a bundle of Patient resources based on query parameters.

API URL:

GET /Patient

QUERY PARAMETERS:

Name Type Required Description
_id long optional

Patient Identifier

Required for patient facing applications

name String optional Name of the patient
birthdate string optional

Birthdate of the patient.

Refer link for input format.

gender string optional

Gender of the patient

Accepted values: male | female | other | unknown

family string optional Patient Family Name
given string optional Patient's given name
identifier string optional Unique identifier of the patient, preferably Patient Record ID.
_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Patient By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Patient", "id": "1036765000000056009", "meta": { "lastUpdated": "2022-11-02T03:00:20.899-07:00" }, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode": "M" }, { "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-race", "extension": [ { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1002-5", "display": "American Indian Or Alaska Native" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1490-2", "display": "Acoma" } }, { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2106-3", "display": "White" } }, { "url": "text", "valueString": "Mixed" } ] } ], "identifier": [ { "system": "https://www.charmhealth.com", "value": "PAT0005" } ], "active": true, "name": [ { "use": "official", "text": "Roger Federer", "family": "Federer", "given": [ "Roger" ] } ], "telecom": [ { "system": "phone", "value": "5557702787", "use": "home" }, { "system": "email", "value": "roger222@gmail.com" } ], "gender": "male", "birthDate": "1940-09-05", "address": [ { "use": "home", "line": [ "599 Schowalter Promenade" ], "city": "West Springfield", "state": "MA", "postalCode": "01089", "country": "us", "period": { "start": "2022-10-14T05:35:41-07:00" } } ], "maritalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "M", "display": "Married" } ], "text": "A current marriage contract is active" }, "communication": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en", "display": "English" } ], "text": "The language which can be used to communicate with the patient about his or her health" } } ] }

Fetches a specific Patient resource.

API URL:

GET /Patient/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Patient.

Search Patient

Request Example

    
curl -X POST /api/ehr/v2/fhir/Patient/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"_id": "1036765000000056009"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "cf0e00eb-212f-401b-8bc9-80e34cf61136", "meta": { "lastUpdated": "2022-11-13T22:36:01.503-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Patient/_search?_id=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Patient/1036765000000056009", "resource": { "resourceType": "Patient", "id": "1036765000000056009", "meta": { "lastUpdated": "2022-11-02T03:00:20.899-07:00" }, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex", "valueCode": "M" }, { "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-race", "extension": [ { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1002-5", "display": "American Indian Or Alaska Native" } }, { "url": "detailed", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "1490-2", "display": "Acoma" } }, { "url": "ombCategory", "valueCoding": { "system": "urn:oid:2.16.840.1.113883.6.238", "code": "2106-3", "display": "White" } }, { "url": "text", "valueString": "Mixed" } ] } ], "identifier": [ { "system": "https://www.charmhealth.com", "value": "PAT0005" } ], "active": true, "name": [ { "use": "official", "text": "Roger Federer", "family": "Federer", "given": [ "Roger" ] } ], "telecom": [ { "system": "phone", "value": "5557702787", "use": "home" }, { "system": "email", "value": "roger222@gmail.com" } ], "gender": "male", "birthDate": "1940-09-05", "address": [ { "use": "home", "line": [ "599 Schowalter Promenade" ], "city": "West Springfield", "state": "MA", "postalCode": "01089", "country": "us", "period": { "start": "2022-10-14T05:35:41-07:00" } } ], "maritalStatus": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus", "code": "M", "display": "Married" } ], "text": "A current marriage contract is active" }, "communication": [ { "language": { "coding": [ { "system": "urn:ietf:bcp:47", "code": "en", "display": "English" } ], "text": "The language which can be used to communicate with the patient about his or her health" } } ] } } ] }

Fetches a bundle of Patient resources based on query parameters.

API URL:

POST /Patient/_search

QUERY PARAMETERS:

Name Type Required Description
_id long optional

Patient Identifier

Required for patient facing applications

name String optional Name of the patient
birthdate string optional

Birthdate of the patient.

Refer link for input format.

gender string optional

Gender of the patient

Accepted values: male | female | other | unknown

family string optional Patient Family Name
given string optional Patient's given name
identifier string optional Unique identifier of the patient, preferably Patient Record ID.
_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Practitioner


        

Use these apis to fetch the Practitioner data.

These apis are in conformance to the US Core Practitioner Profile

List Practitioner

Request Example

    
curl -X GET /api/ehr/v2/fhir/Practitioner?name=Albert Davis -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "86039520-cbc7-4e5b-900f-a4e408035e4c", "meta": { "lastUpdated": "2022-09-23T13:06:21.155+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Practitioner" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Practitioner/1036765000000021021", "resource": { "resourceType": "Practitioner", "id": "1036765000000021021", "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000021021" }, { "system": "http://hl7.org/fhir/sid/us-npi", "value": "1245319599" } ], "active": true, "name": [ { "text": "Albert Davis", "family": "Davis", "given": [ "Albert" ], "prefix": [ "Dr" ] } ], "telecom": [ { "system": "phone", "value": "5555551003", "use": "work" }, { "system": "phone", "value": "9790987413", "use": "mobile" }, { "system": "email", "value": "albert12@gmail.com", "use": "work" } ], "address": [ { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton,", "state": "Oregon", "postalCode": "97006" } ], "gender": "male" } } ] }

Fetches a bundle of Practitioner resources based on query parameters.

API URL:

GET /Practitioner

QUERY PARAMETERS:

Name Type Required Description
name String optional Name of the practitioner
identifier string optional Practitioner identifier
page integer optional Page Number of the list

Get Practitioner By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/Practitioner/1036765000000021021 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Practitioner", "id": "1036765000000021021", "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000021021" }, { "system": "http://hl7.org/fhir/sid/us-npi", "value": "1245319599" } ], "active": true, "name": [ { "text": "Albert Davis", "family": "Davis", "given": [ "Albert" ], "prefix": [ "Dr" ] } ], "telecom": [ { "system": "phone", "value": "5555551003", "use": "work" }, { "system": "phone", "value": "9790987413", "use": "mobile" }, { "system": "email", "value": "albert12@gmail.com", "use": "work" } ], "address": [ { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton,", "state": "Oregon", "postalCode": "97006" } ], "gender": "male" }

Fetches a specific Practitioner resource.

API URL:

GET /Practitioner/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the practitioner.

Search Practitioner

Request Example

    
curl -X POST /api/ehr/v2/fhir/Practitioner/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"identifier": "1036765000000021021"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "4b8db254-0d84-4528-b793-04f5ef6524dd", "meta": { "lastUpdated": "2022-09-23T13:08:11.024+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Practitioner/_search" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Practitioner/1036765000000021021", "resource": { "resourceType": "Practitioner", "id": "1036765000000021021", "identifier": [ { "system": "https://www.charmhealth.com", "value": "1036765000000021021" }, { "system": "http://hl7.org/fhir/sid/us-npi", "value": "1245319599" } ], "active": true, "name": [ { "text": "Albert Davis", "family": "Davis", "given": [ "Albert" ], "prefix": [ "Dr" ] } ], "telecom": [ { "system": "phone", "value": "5555551003", "use": "work" }, { "system": "phone", "value": "9790987413", "use": "mobile" }, { "system": "email", "value": "albert12@gmail.com", "use": "work" } ], "address": [ { "use": "work", "line": [ "2472, Rocky place" ], "city": "Beaverton,", "state": "Oregon", "postalCode": "97006" } ], "gender": "male" } } ] }

Fetches a bundle of Practitioner resources based on query parameters.

API URL:

POST /Practitioner/_search

QUERY PARAMETERS:

Name Type Required Description
name String optional Name of the practitioner
identifier string optional Practitioner identifier
page integer optional Page Number of the list

Procedure


        

Use these apis to fetch the Procedure data recorded for patients.

These apis are in conformance to the US Core Procedure Profile

List Procedure

Request Example

    
curl -X GET /api/ehr/v2/fhir/Procedure?patient=Patient/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "82184306-c4f5-4c55-a485-7c1a810eae10", "meta": { "lastUpdated": "2022-11-13T22:38:28.133-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Procedure?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Procedure/1036765000000106877", "resource": { "resourceType": "Procedure", "id": "1036765000000106877", "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "119252009", "display": "Papanicolaou test" } ], "text": "Papanicolaou test" }, "subject": { "reference": "Patient/1036765000000056009" }, "performedPeriod": { "start": "2022-09-19T00:00:00-07:00" }, "recorder": { "reference": "Practitioner/1036765000000021021" }, "report": [ { "reference": "DocumentReference/1036765000000106877-PC" } ] } } ] }

Fetches a bundle of Procedure resources based on query parameters.

API URL:

GET /Procedure

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

code string optional

The specific procedure that is performed.

Include codes from SNOMED list.

date string optional

Estimated or actual date or date-time when the procedure was performed.

Refer link for input format.

status string optional

A code specifying the state of the procedure.

Accepted values: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get Procedure By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/Procedure/1036765000000154121 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Procedure", "id": "1036765000000154121", "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "11728004", "display": "Infusion of gas gangrene antitoxin" } ], "text": "Infusion of gas gangrene antitoxin" }, "subject": { "reference": "Patient/1036765000000056009" }, "performedPeriod": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason", "valueCode": "unknown" } ] }, "recorder": { "reference": "Practitioner/1036765000000021021" }, "report": [ { "reference": "DocumentReference/1036765000000154121-PC" } ] }

Fetches a specific Procedure resource.

API URL:

GET /Procedure/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the Procedure.

Search Procedure

Request Example

    
curl -X POST /api/ehr/v2/fhir/Procedure/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "1036765000000056009","status": "completed"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "5e4e4f36-5d82-4110-9ff6-a166d8ec6878", "meta": { "lastUpdated": "2022-11-13T22:38:28.571-08:00" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Procedure/_search?patient=1036765000000056009" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Procedure/1036765000000106877", "resource": { "resourceType": "Procedure", "id": "1036765000000106877", "status": "completed", "code": { "coding": [ { "system": "http://snomed.info/sct", "code": "119252009", "display": "Papanicolaou test" } ], "text": "Papanicolaou test" }, "subject": { "reference": "Patient/1036765000000056009" }, "performedPeriod": { "start": "2022-09-19T00:00:00-07:00" }, "recorder": { "reference": "Practitioner/1036765000000021021" }, "report": [ { "reference": "DocumentReference/1036765000000106877-PC" } ] } } ] }

Fetches a bundle of Procedure resources based on query parameters.

API URL:

POST /Procedure/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Required for patient facing applications

code string optional

The specific procedure that is performed.

Include codes from SNOMED list.

date string optional

Estimated or actual date or date-time when the procedure was performed.

Refer link for input format.

status string optional

A code specifying the state of the procedure.

Accepted values: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Provenance


        

Use these apis to fetch the Provenance data recorded for patients.

These apis are in conformance to the US Core Provenance Profile

Get Provenance By ID

Request Example

    
curl -X GET /api/ehr/v2/fhir/Provenance/1036765000000056009 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Provenance", "id": "1036765000000056009", "target": [ { "reference": "Patient/1036765000000056009" }, { "reference": "AllergyIntolerance/1036765000000065017" }, { "reference": "Goal/1036765000000122003" }, { "reference": "CarePlan/1036765000000102063" }, { "reference": "CarePlan/1036765000000102079" }, { "reference": "CareTeam/1036765000000056009" }, { "reference": "DocumentReference/1036765000000102095" }, { "reference": "MedicationRequest/1036765000000106237" }, { "reference": "Medication/1036765000000101023" }, { "reference": "Encounter/1036765000000102095" }, { "reference": "Condition/1036765000000102023" }, { "reference": "Device/1036765000000103285" }, { "reference": "Immunization/1036765000000116739" }, { "reference": "Observation/1036765000000056009-ss" }, { "reference": "Observation/1036765000000143021-bw" }, { "reference": "Observation/1036765000000102239-bp" }, { "reference": "Procedure/1036765000000154121" }, { "reference": "Procedure/1036765000000106877" }, { "reference": "Appointment/100002000000010027" }, { "reference": "FamilyMemberHistory/100002000000016009" }, { "reference": "MedicationAdministration/100001000000016079" }, { "reference": "QuestionnaireResponse/100001000000016161" }, { "reference": "RelatedPerson/100001000000198115" }, ], "recorded": "2022-11-02T03:00:20.899-07:00", "agent": [ { "type": { "coding": [ { "system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type", "code": "author", "display": "Author" } ], "text": "Author" }, "who": { "reference": "Practitioner/1036765000000021021" }, "onBehalfOf": { "reference": "Organization/1036765000000021089" } }, { "type": { "coding": [ { "system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type", "code": "transmitter", "display": "Transmitter" } ], "text": "Transmitter" }, "who": { "reference": "Practitioner/1036765000000021021" }, "onBehalfOf": { "reference": "Organization/1036765000000021089" } } ] }

Fetches a specific Provenance resource.

API URL:

GET /Provenance/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the provenance

QuestionnaireResponse


        

Use these apis to fetch the QuestionnaireResponse data recorded for patients.

These apis are in conformance to the US Core QuestionnaireResponse Profile

List QuestionnaireResponse

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/QuestionnaireResponse?patient=Patient/100001000000015007 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "24df428b-30da-44ee-9b1c-69486cad9b45", "meta": { "lastUpdated": "2023-10-31T15:53:52.489+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/QuestionnaireResponse?patient=Patient/100001000000015007" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/QuestionnaireResponse/100001000000016161", "resource": { "resourceType": "QuestionnaireResponse", "id": "100001000000016161", "status": "in-progress", "subject": { "reference": "Patient/100001000000015007" }, "encounter": { "reference": "Encounter/100001000000016067" }, "authored": "2023-10-31T15:53:33+05:30", "author": { "reference": "Practitioner/100001000000000109" }, "source": { "reference": "Patient/100001000000015007" }, "item": [ { "text": "Diabetes Risk Assessment Questionnaire", "answer": [ { "valueUri": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/QuestionnaireResponse/100001000000016161/pdf" } ] } ] } } ] }

Fetches a bundle of QuestionnaireResponse resources based on query parameters.

API URL:

GET /QuestionnaireResponse

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

status string optional

The status of the questionnaire response.

Accepted values: completed | in-progress

date string optional

Date of the questionnaire response.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get QuestionnaireResponse By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/QuestionnaireResponse/100001000000016161 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "QuestionnaireResponse", "id": "100001000000016161", "status": "in-progress", "subject": { "reference": "Patient/100001000000015007" }, "encounter": { "reference": "Encounter/100001000000016067" }, "authored": "2023-10-31T15:53:33+05:30", "author": { "reference": "Practitioner/100001000000000109" }, "source": { "reference": "Patient/100001000000015007" }, "item": [ { "text": "Diabetes Risk Assessment Questionnaire", "answer": [ { "valueUri": "https://ehr2.charmtracker.com/api/ehr/v1/questionnaire/answer/100001000000016161/pdf" } ] } ] }

Fetches a specific QuestionnaireResponse resource.

API URL:

GET /QuestionnaireResponse/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the questionnaireresponse.

Search QuestionnaireResponse

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/QuestionnaireResponse/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/100001000000015007","date": "gt2023-08-10T12:30:00-05:30"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "24df428b-30da-44ee-9b1c-69486cad9b45", "meta": { "lastUpdated": "2023-10-31T15:53:52.489+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/QuestionnaireResponse?patient=Patient/100001000000015007&date=gt2023-08-10T12:30:00-05:30" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/QuestionnaireResponse/100001000000016161", "resource": { "resourceType": "QuestionnaireResponse", "id": "100001000000016161", "status": "in-progress", "subject": { "reference": "Patient/100001000000015007" }, "encounter": { "reference": "Encounter/100001000000016067" }, "authored": "2023-10-31T15:53:33+05:30", "author": { "reference": "Practitioner/100001000000000109" }, "source": { "reference": "Patient/100001000000015007" }, "item": [ { "text": "Diabetes Risk Assessment Questionnaire", "answer": [ { "valueUri": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/QuestionnaireResponse/100001000000016161/pdf" } ] } ] } } ] }

Fetches a bundle of QuestionnaireResponse resources based on query parameters.

API URL:

POST /QuestionnaireResponse/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Patient Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

status string optional

The status of the questionnaire response.

Accepted values: completed | in-progress

date string optional

Date of the questionnaire response.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

RelatedPerson


        

Use these apis to fetch the RelatedPerson data recorded for patients.

These apis are in conformance to the US Core RelatedPerson Profile

List RelatedPerson

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/RelatedPerson?patient=Patient/100001000000198091 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "29044aea-707a-4405-9585-6a6015e8b814", "meta": { "lastUpdated": "2023-10-31T18:50:43.593+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/RelatedPerson?patient=Patient/100001000000198091" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/RelatedPerson/100001000000198115", "resource": { "resourceType": "RelatedPerson", "id": "100001000000198115", "active": true, "patient": { "reference": "Patient/100001000000198091" }, "relationship": [ { "text": "Child" } ], "name": [ { "text": "Grace Lawson", "family": "Lawson", "given": [ "Grace" ] } ], "telecom": [ { "system": "phone", "value": "7777777777", "use": "mobile" }, { "system": "phone", "value": "4444444444", "use": "home" }, { "system": "phone", "value": "8888888888", "use": "work" }, { "system": "email", "value": "grace@gmail.com" } ], "gender": "male", "birthDate": "2014-10-15", "address": [ { "use": "home", "line": [ "Second cross 1223", "Milestone RD" ], "city": "PUNGOTEAGUE", "state": "VA", "postalCode": "23422-1546", "country": "us" } ] } } ] }

Fetches a bundle of RelatedPerson resources based on query parameters.

API URL:

GET /RelatedPerson

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Actor (Patient, Practitioner, Location) Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

name string optional

The name of the related person.

address string optional

The address of the related person.

date string optional

Date of the related person.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

Get RelatedPerson By ID

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/RelatedPerson/100001000000198115 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 200 OK { "resourceType": "RelatedPerson", "id": "100001000000198115", "active": true, "patient": { "reference": "Patient/100001000000198091" }, "relationship": [ { "text": "Child" } ], "name": [ { "text": "Grace Lawson", "family": "Lawson", "given": [ "Grace" ] } ], "telecom": [ { "system": "phone", "value": "7777777777", "use": "mobile" }, { "system": "phone", "value": "4444444444", "use": "home" }, { "system": "phone", "value": "8888888888", "use": "work" }, { "system": "email", "value": "grace@gmail.com" } ], "gender": "male", "birthDate": "2014-10-15", "address": [ { "use": "home", "line": [ "Second cross 1223", "Milestone RD" ], "city": "PUNGOTEAGUE", "state": "VA", "postalCode": "23422-1546", "country": "us" } ] }

Fetches a specific RelatedPerson resource.

API URL:

GET /RelatedPerson/{id}

PATH PARAMETERS:

Name Type Required Description
id long required ID of the relatedperson.

Search RelatedPerson

Request Example

    
$ curl -X POST /api/ehr/v2/fhir/RelatedPerson/_search -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -d {"patient": "Patient/100001000000198091","name": "Grace"}

Response Example

HTTP/1.1 200 OK { "resourceType": "Bundle", "id": "29044aea-707a-4405-9585-6a6015e8b814", "meta": { "lastUpdated": "2023-10-31T18:50:43.593+05:30" }, "type": "searchset", "total": 1, "link": [ { "relation": "self", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/RelatedPerson?patient=Patient/100001000000198091&name=Grace" } ], "entry": [ { "fullUrl": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/RelatedPerson/100001000000198115", "resource": { "resourceType": "RelatedPerson", "id": "100001000000198115", "active": true, "patient": { "reference": "Patient/100001000000198091" }, "relationship": [ { "text": "Child" } ], "name": [ { "text": "Grace Lawson", "family": "Lawson", "given": [ "Grace" ] } ], "telecom": [ { "system": "phone", "value": "7777777777", "use": "mobile" }, { "system": "phone", "value": "4444444444", "use": "home" }, { "system": "phone", "value": "8888888888", "use": "work" }, { "system": "email", "value": "grace@gmail.com" } ], "gender": "male", "birthDate": "2014-10-15", "address": [ { "use": "home", "line": [ "Second cross 1223", "Milestone RD" ], "city": "PUNGOTEAGUE", "state": "VA", "postalCode": "23422-1546", "country": "us" } ] } } ] }

Fetches a bundle of RelatedPerson resources based on query parameters.

API URL:

POST /RelatedPerson/_search

QUERY PARAMETERS:

Name Type Required Description
patient string optional

Actor (Patient, Practitioner, Location) Reference.

Refer Identifer for input format.

Patient reference required for patient facing applications

name string optional

The name of the related person.

address string optional

The address of the related person.

date string optional

Date of the related person.

Refer link for input format.

_revinclude string optional

Includes additional resources referred to this resource.

Accepted value: Provenance:target

page integer optional Page Number of the list

CCDA

Fetches the entire patients' data in the Clinical Document Architecture (CDA) style.

Request Example

$ curl -X GET https://ehr2.charmtracker.com/api/ehr/v2/fhir/patients/1036765000000034005/ccda -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -H "api_key: 9f72e9eed37ad04d68590b221d47e63c"

Response Example

HTTP/1.1 200 OK Content-Disposition: attachment; filename="100001000000023049_CCDA.xml" Content-Type: application/xml;charset=UTF-8

Export medical records of a patient in HL7 CCDA format.

By default, the API exports all records of the patient across dates.You can use the optional query parameters listed below to filter the records by date. To get the records on a specific date, give the same date in 'from_date' and 'to_date' parameters.

API URL:

GET /patients/{patient_id}/ccda

QUERY PARAMETERS:

Name Type Required Description
from_date string optional Date of Record (Format: YYYY-MM_DD)
to_date string optional Date of Record (Format: YYYY-MM_DD)

Bulk Export


        

Exports the data of more than one resource of the group of patients.

Refer Bulk Export for more details.

Start Bulk Export

Request Example

    
$ curl -X GET https://ehr2.charmtracker.com/api/ehr/v2/fhir/Group/10121000000221111/$export? -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5" -H 'content-type: application/json'

Response Example

HTTP/1.1 200 OK content-location https://ehr2.charmtracker.com/api/ehr/v2/fhir/$export-poll-status?_jobid=1012100000208061 { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "processing", "diagnostics": "Your request has been accepted. You can check its status at \"https://ehr2.charmtracker.com/api/ehr/v2/fhir/$export-poll-status?_jobid=1012100000208061\"" } ] }

Start the bulk export for the given patients

You will get the Job ID of the export action in the content-location response header. You can use this Job ID in the subsequent APIs to query the export status and the exported files.

API URL:

GET /Group/{group_id}/$export

PATH PARAMETERS:

Name Type Required Description
group_id long required ID of the Patient Category (Group).

Get Bulk Export status

Fetches the status of the bulk export request

You will get a HTTP response code 202, when the request is in progress. Once the export is completed, you will get a 200 response code along with the URLs to download the exported files.

Request Example

    
$ curl -X GET /api/ehr/v2/fhir/$export-poll-status?_jobid=1012100000208061 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 202 ACCEPTED { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "processing", "diagnostics": "Your request has been accepted. You can check its status at \"https://ehr2.charmtracker.com/api/ehr/v2/fhir/$export-poll-status?_jobid=1012100000208061\"" } ] }
HTTP/1.1 200 OK { "requiresAccessToken": true, "output": [ { "type": "Patient", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Binary/Patient/b8775ca2fd64a4d423c3e73bd587fba580eaa" }, { "type": "Encounter", "url": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/Binary/Encounter/fd64a4d423c3e73bd58ea93955cf863e0679" } ], "request": "https://ehr2.charmtracker.com/api/ehr/v2/fhir/$export-poll-status?_jobid=1012100000208061", "deleted": [], "transactionTime": "Sun Nov 13 22:54:50 PST 2022", "error": [] }

API URL:

GET /$export-poll-status

QUERY PARAMETERS:

Name Type Description
_jobid long Job Identifier

Delete Bulk Export Request

Request Example

    
$ curl -X DELETE /api/ehr/v2/fhir/$export-poll-status?_jobid=1012100000208061 -H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"

Response Example

HTTP/1.1 202 ACCEPTED { "resourceType": "OperationOutcome", "issue": [ { "severity": "information", "code": "deleted", "diagnostics": "Your request has been deleted." } ] }

Deletes the Bulk Export Request, that was initiated.

API URL:

DELETE /$export-poll-status

QUERY PARAMETERS:

Name Type Description
_jobid long Job Identifier