Curl Request

Introduction

ChARM 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 ChARM 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 ChARM EHR user interface.

FHIR Base URL

The base URL for accessing all the ChARM 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 ChARM EHR. Patients need to use their ChARM 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 ChARM 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 ChARM 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 ChARM 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 ChARM 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.

User Scopes

The scopes below are used for Provider facing applications.

System Scopes

The scopes below are used for Backend Service applications.

Other scopes

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

Authentication

ChARM 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 ChARM 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:

• scope=<Scopes for which token to be generated> Eg : patient/Patient.read
• client_id=<The Client ID provided to the developer after registration>
• state=<An opaque string for application developers, it will returned as a URI parameter>
• response_type=code
• redirect_uri=<Redirect URI of your choice (https://app.example.com/oauth)>

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:

• code=<Code obtained in the above step>
• client_id=<The Client ID provided to the developer after registration>
• client_secret=<The Client Secret provided to the developer after registration>
• redirect_uri=<Same URI that was used in the previous step>
• grant_type=authorization_code

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:

• refresh_token=<Refresh Token obtained in the above step>
• client_id=<The Client ID provided to the developer after registration>
• client_secret=<The Client Secret provided to the developer after registration>
• redirect_uri=<Same URI that was used in the above step>
• grant_type=refresh_token

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.

ChARM 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:

• scope=<Scopes for which token to be generated> Eg : patient/Patient.read
• client_id=<The Client ID provided to the developer after registration>
• state=<An opaque string for application developers, it will returned as a URI parameter>
• response_type=code
• redirect_uri=<https://app.example.com/oauth (Redirect URI of your choice)>
• code_challenge=SHA256 encoded version of code_verifier
• code_challenge_method=SHA256

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:

• code=<Code obtained in the above step>
• client_id=<The Client ID provided to the developer after registration>
• redirect_uri=<Same URI that was used in the previous step>
• grant_type=authorization_code
• code_verifier=This will be verified against the code_challenge parameter from the previous request.

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 ChARM 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 ChARM 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:

• grant_type=client_credentials
• client_assertion_type=<This should be set to urn:ietf:params:oauth:client-assertion-type:jwt-bearer>
• client_assertion=<JWT token created in the previous step>
• scope=<System Scope>

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 ChARM EHR account.

Response Codes

ChARM 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

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": "2022-11-08T22:57:41-08:00",
  "kind": "instance",
  "software": {
    "name": "ChARM 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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-patient.html"
          ],
          "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/STU3.1.1/StructureDefinition-us-core-allergyintolerance.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-goal.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careplan.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-careteam.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-condition.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-implantable-device.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-diagnosticreport-note.html",
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-diagnosticreport-lab.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-immunization.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": "Medication",
          "supportedProfile": [
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medication.html"
          ],
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "history-instance"
            }
          ]
        },
        {
          "type": "MedicationRequest",
          "supportedProfile": [
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-medicationrequest.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-smokingstatus.html",
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-pediatric-weight-for-height.html",
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-observation-lab.html",
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-pediatric-bmi-for-age.html",
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-pulse-oximetry.html",
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-head-occipital-frontal-circumference-percentile.html",
            "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-procedure.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-encounter.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-organization.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-practitioner.html"
          ],
          "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://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-provenance.html"
          ],
          "interaction": [
            {
              "code": "search-type"
            },
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "history-instance"
            }
          ]
        },
        {
          "type": "Location",
          "supportedProfile": [
            "http://www.hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-location.html"
          ],
          "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": "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:

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:

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:

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:

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:

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:

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:

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:

Search CareTeam

Request Example

    

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

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:

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:

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:

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:

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:

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:

Search Device

Request Example

    

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

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:

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.

• US Core DiagnosticReport Profile for Report and Note exchange
• US Core DiagnosticReport Profile for Laboratory Results Reporting

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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.

• US Core Smoking Status Observation Profile
• US Core Pediatric Weight for Height Observation Profile
• US Core Laboratory Result Observation Profile
• US Core Pediatric BMI for Age Observation Profile
• US Core Pulse Oximetry Profile
• US Core Pediatric Head Occipital-frontal Circumference Percentile Profile

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:

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:

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:

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:

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:

Search Organization

Request Example

    

        
curl -X POST /api/ehr/v2/fhir/Organization/_search
-H "Authorization: Bearer ba4604e8e433g9c892e360d53463oec5"
-d {"patient": "Patient/100001000000006399","status": "finished","date": "gt2022-08-10T12:30:00-05:30","class": "AMB","page": "2"}
        
    

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:

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?patient=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": "charmphrcures2022@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:

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": "charmphrcures2022@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:

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": "charmphrcures2022@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:

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": "charmehrcures2022@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:

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": "charmehrcures2022@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:

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": "charmehrcures2022@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:

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:

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:

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:

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"
    }
  ],
  "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:

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:

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:

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:

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: