Introduction
GlaceEMR API development is to help medical practices to share more patient data with other authorized networks. To provide consistent interoperability across different disconnected systems GlaceEMR API follows the HL7 FHIR standard. More information can be found at the FHIR website.
GlaceEMR API is based on R4 of the FHIR standard. It uses the Data Access Framework (DAF) profile.Updates and definitions for use of DAF for Meaningful Use 2015 Edition can be found on the HL7 Wiki.
GlaceEMR API is a RESTful implementation for an API. At a high level this means several things.
- FHIR is resource-based. The resources are healthcare or related resources, for example patient or medication. All resources have an identifier that can be used to access or reference them.
- FHIR resources are accessed through HTTPS and use the HTTP verb GET.
GlaceEMR API provides the following resources
- Patient
- Allergy or Intolerance
- Care Team
- Plan of Care
- Device
- Diagnostic Report
- Encounter
- Goals
- Condition
- Immunization
- Location
- Medication Request
- Organization
- Observation
- Document Reference
As per the FHIR standard, the response contains resources which are independent and can reference other resources. They are not inter-dependent, so you don't need other resources to correctly interpret a resource. Resources reference each other extensively to form a web of information. You need to resolve references to fully understand the data. A reference is relative to a server-based URL.
Example : Reference between Resources
Authentication and Authorization
Confidential Clients
Our APIs are secured by an OAuth 2.0 authorization server. App developers that register with GlaceEMR are therefore issued OAuth client credentials used to request access tokens (a type of JSON web token, or 'JWT' - pronounced 'jot') from our authorization server. An access token represents an app's authorized access to one or more API endpoints used to read, write, or update data in athenaOne, where an app is required to provide an access token to make a successful request to those endpoints.
GlaceEMR supports the following authentication and authorization methods for Confidential Clients:
| App Type | Authentication | Grant-Type | O-Auth Flow |
|---|---|---|---|
| Standalone Launch | Symmetric (Shared Secret) | Authorization Code | 3-legged |
| EHR Launch | Symmetric (Shared Secret) | Authorization Code | 3-legged |
| Bulk-Data | Asymmetric (Public Key) | Client Credentials | 2-legged |
Non-Confidential Clients
For native/public applications that cannot store a secret, PKCE is not required. The application can register as a public stand-alone launch app. The application can authorize using the 'authorization code' grant type.
2-legged OAuth apps
- system/AllergyIntolerance.read
- system/Binary.read
- system/CarePlan.read
- system/CareTeam.read
- system/Condition.read
- system/Device.read
- system/DiagnosticReport.read
- system/DocumentReference.read
- system/Encounter.read
- system/Goal.read
- system/Immunization.read
- system/Location.read
- system/Medication.read
- system/MedicationRequest.read
- system/Observation.read
- system/Organization.read
- system/Patient.read
- system/Practitioner.read
- system/Procedure.read
- system/Provenance.read
Note:The scopes listed above are for 2-legged access using scopes of type 'system', whereas scopes of type 'user' and 'patient' are exclusive to 3-legged access.
Available Scopes for 3-Legged OAuth Apps
- openid
- fhirUser
- offline_access
Automatic approval of scopes for 3-legged OAth apps also extends to the necessary scopes for each app's intended SMART App Launch sequence, as well as those FHIR scopes corresponding to US Core resources and GlaceEMR's certified APIs. All FHIR APIs require the use of OAuth scopes using the SMART App Launch Framework v1.0.0 clinical scope syntax. The syntax for these scopes is:
clinical-scope = ('patient' | 'user' | 'system') '/' ([fhir-resource] | '*') '.' ('read' | 'write' | '*')
For example, 'patient/AllergyIntolerance.read' would allow an application to read a patient's AllergyIntolerance information on that patient's behalf.
By default, GlaceEMR does not permit apps to request wildcard scopes (those containing '*', such as 'patient/*.read', 'patient.AllergyIntolerance.*', or 'patient/*.*'), which provide access to all FHIR resources or permissions, nor does GlaceEMR permit write scopes (e.g., patient/AllergyIntolerance.write).
For patient-facing apps using 3-legged OAuth
- launch/patient
- patient/Appointment.rs
- patient/Assessment.rs
- patient/Binary.rs
- patient/AllergyIntolerance.rs
- patient/CarePlan.rs
- patient/CareTeam.rs
- patient/ClinicalImpression.rs
- patient/Condition.rs
- patient/Device.rs
- patient/DiagnosticReport.rs
- patient/DocumentReference.rs
- patient/Encounter.rs
- patient/Goal.rs
- patient/Immunization.rs
- patient/Location.rs
- patient/MedicalAdministration.rs
- patient/Medication.rs
- patient/MedicationDispense.rs
- patient/MedicationOrder.rs
- patient/MedicationRequest.rs
- patient/MedicationStatement.rs
- patient/Observation.rs
- patient/Organization.rs
- patient/Patient.rs
- patient/PracticeConfiguration.rs
- patient/Practitioner.rs
- patient/Procedure.rs
- patient/Provenance.rs
- patient/Provider.rs
- patient/Media.rs
- patient/Specimen.rs
- patient/Coverage.rs
For provider-facing apps using 3-legged OAuth
- launch
- user/AllergyIntolerance.rs
- user/Appointment.rs
- user/Assessment.rs
- user/Binary.rs
- user/CarePlan.rs
- user/CareTeam.rs
- user/ClinicalImpression.rs
- user/Condition.rs
- user/Device.rs
- user/DiagnosticReport.rs
- user/DocumentReference.rs
- user/Encounter.rs
- user/Goal.rs
- user/Immunization.rs
- user/Location.rs
- user/MedicalAdministration.rs
- user/Medication.rs
- user/MedicationDispense.rs
- user/MedicationOrder.rs
- user/MedicationRequest.rs
- user/MedicationStatement.rs
- user/Observation.rs
- user/Organization.rs
- user/Patient.rs
- user/PracticeConfiguration.rs
- user/Practitioner.rs
- user/Procedure.rs
- user/Provenance.rs
- user/Provider.rs
- patient/Media.rs
- patient/Specimen.rs
- patient/Coverage.rs
Note: The scopes listed above are for 3-legged access using scopes of type 'patient' and 'user'. Scopes of type 'system' are exclusive to 2-legged access, such as system-to-system calls that do not include a user.
Token Endpoint
The OAuth token endpoint is used to obtain access tokens. An access token must be provided as a bearer token with any request to an API used to read, write, or update data in GlaceEMR.
The sequence for calling the token endpoint is different for apps using 2-legged OAuth versus 3-legged OAuth: An app using 2-legged OAuth can call the token endpoint directly to obtain an access token, while an app using 3-legged OAuth must first call the authorize endpoint to request and obtain consent from an end user, such as a provider or patient. As a byproduct of end user authorization, the token endpoint response for 3-legged OAuth may also contain an ID token, refresh token, or launch context (see Output Parameters & Token Types section below for details), whereas only an access token is returned for 2-legged OAuth.
We support 4 methods of authenticating apps against the token endpoint, some of which are exclusive to your app's authorization method and selected app type when registering your application. Refer to the sections below for details on token endpoint authentication using each method:
- Using a client secret is the simplest method, which requires you to provide your client ID and secret in a basic authorization header when calling the token API.
- Using an imported public JWKS (JSON Web Key Set) (2-legged OAuth and 3-legged OAuth web apps only) is more complex, but also more secure. A JWT (JSON Web Token) is generated and signed with a public/private keypair by the caller and presented to the token endpoint. The call is authenticated if the JWT's signature can be verified using one of the app's public keys.
- Using a self-hosted JWKS URL (2-legged OAuth and 3-legged OAuth web apps only) is potentially the most secure method by giving you direct control over the JWKS and key rotation. The overall pattern for JWT generation and authentication follows that of an imported public JWKS, except that JWT signature and verification references a self-hosted URL as opposed to a public one.
- Using a proof key for code exchange, or 'PKCE' - pronounced 'pixie' (3-legged OAuth only), requires you to generate your own secret for each token request that can be verified by GlaceEMR's authorization server. PKCE is required by the token API for native or single-page browser apps that cannot securely store a client secret.
Token Authentication Using Client Secret
When using secret-based authentication, your app will have a client secret associated with its client ID. This secret will be passed in a basic authorization header on every request to the token endpoint.
Please remember that as a security measure, you should never share your client ID or secret. If this happens, we will need to create another set of credentials associated with your account.
Token Generation
To request a token using secret-based authentication, make a request with the following parameters utilizing basic authentication to include your client ID and client secret in a basic authorization header.
curl https://auth.glaceemr.com/realms/fhir/protocol/openid-connect/token \
-X POST \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-d "grant_type=client_credentials" \
-d "scope=glaceemr/service/glaceemr.MDP.*"
Troubleshooting
There is a common error that involves POSTing the username and password. This does not work. It must use basic authentication (essentially, "$key:$secret" Base64 encoded).
Token Authentication Using JWKS (JSON Web Key Sets)
Client-assertion JWT-based (JSON Web Token) authentication uses a public/private keypair to authenticate the caller to the token endpoint (see here for information on how to generate public/private keypairs). Using this approach, your application will have no client secret. You must associate at least one public key with your application via a self-hosted JWKS (JSON Web Key Set) URL or by importing your public JWKS.
JWT-based authentication with JWKS is more involved for the end-user, requiring you to generate keypairs and sign JWT assertions to retrieve a token. The benefit of using this method is that it is more secure as the private portion of your keypair is never out of your hands (note: using the self-hosted JWKS URL provides even further control and security versus importing your public JWKS by granting you ownership of your keys and key rotation). Using JWKS also enables zero-downtime rotation of credentials. You can have multiple public keys associated with your app (recommended to have 1-5 keys) enabling you to rotate by introducing a new keypair, transitioning your code to use this new keypair, and then deleting the old keypair.
Forming the JWT Assertion
Requesting a token using the client assertion JWT-method requires that you sign a JWT assertion using the private portion of a keypair associated with your app. This assertion is then provided to the token endpoint for authentication. The assertion JWT must contain the following claims:
|
Claim |
Description |
Type |
|
aud |
Required. The URL of the backend authorization resource. This varies by environment, listed below.
|
string |
|
exp |
Required. An expiration time for this token in seconds since the epoch. Must be less than an hour into the future. The assertion token will no longer be valid after this time expires. |
number |
|
iss |
Required. Set to the client ID of the application for which you're requesting a token. |
string |
|
sub |
Required. Set to the client ID of the application for which you're requesting a token. |
string |
Requesting the Token
To request a token with the JWT you've generated, include the JWT along with the other parameters as demonstrated below:
# Construct the client assertion JWT using a script like the above.
JWT=$(node generate-jwt.js)
# Include the JWT in a token request with the appropriate parameters for the
# environment.
curl -X POST "https://api.preview.platform.GlaceEMR.com/oauth2/v1/token" \
-H "Accept: application/json" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "scope=glaceemr/service/glaceemr.MDP.*" \
-d "client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer" \
-d "client_assertion=$JWT"
Token Authentication Using PKCE
Consistent with OAuth best practice and SMART App Launch v2.0.0 proposals, token authentication using PKCE is required by GlaceEMR's authorization server for native or single-page browser apps using 3-legged OAuth that cannot securely store a client secret. PKCE is an enhancement to the OAuth 2.0 Authorization Code Flow that requires your app to generate its own secret for each token request (called a 'code verifier') that can be verified by GlaceEMR's authorization server (using a transformed value of the code verifier called a 'code challenge', which is passed in the authorize request along with the transformation method, or 'code challenge method'). The code challenge and code challenge method must be provided in your app's authorize request and the code verifier sent in the token request.
To leverage PKCE for your app, please refer to the IETF's official PKCE overview for details and restrictions of the code verifier, code challenge, and code challenge method parameters.
Input Parameters
IMPORTANT: Endpoint requires client authentication. Refer to samples in sections above for token authentication method applicable to your app.
* = required
| grant_type* | string |
For 2-legged OAuth, the value is always client_credentials. For 3-legged OAuth, either the value is authorization_code to initially request an access token, or the value is refresh_token to obtain a new access token from a refresh token. |
|
redirect_uri |
string |
Required if grant_type is authorization_code (3-legged OAuth only). The value is the post-login redirect URI for your app and must match the value for redirect_uri provided to the authorize endpoint. |
|
code |
string |
Required if grant_type is authorization code (3-legged OAuth only). The value is the code parameter returned by the authorize endpoint. |
|
code_verifier |
string |
Required for token authentication using PKCE if grant_type is authorization_code (3-legged OAuth only) and your app cannot securely store or does not have a client secret. The value is a one-time use, unique string generated by your app. |
|
refresh_token |
string |
Required if grant_type is refresh_token. The value is the refresh token returned by the authorize endpoint. |
|
scope |
string |
Required if grant_type is client_credentials (2-legged OAuth) or refresh_token (3-legged OAuth only). The value is a space-delimited, case-sensitive string of requested scopes. If grant_type is refresh_token, the requested scopes must be a subset of those provided to the authorize endpoint when the refresh token was originally generated. |
Output Parameters & Token Types
The token endpoint returns a JSON object including up to 3 types of JWTs and associated information:
- access_token - JWT to be used as a bearer token in subsequent API requests
- token_type - describes the access token; value is always 'Bearer'
- expires_in - represents the lifetime of the access token in seconds (default is 60 minutes for 2-legged OAuth and 3-legged OAuth apps)
- id_token - JWT containing information on the authenticated end user (3-legged OAuth only)
- refresh_token - JWT used to obtain a new access token without requiring re-authentication by an end user (3-legged OAuth only; default expiration is 90 days from the most recent token request that used or generated that refresh token)
If using 2-legged OAuth, the token response has the following format:
{
"access_token": "bSQeVaRd47Tnof8GWbDZTud9ghLP",
"expires_in": "300"
}
If using 3-legged OAuth, the token response has the following format:
{"token_type":"Bearer","expires_in":300,"access_token":"N09411aa6CiXmdNnkp6l7V6lk5UH","scope":"openid fhirUser offline_access launch/patient patient/AllergyIntolerance.read patient/CarePlan.read patient/CareTeam.read patient/Condition.read patient/Device.read patient/DiagnosticReport.read patient/DocumentReference.read patient/Encounter.read patient/Goal.read patient/Immunization.read patient/Location.read patient/Medication.read patient/MedicationRequest.read patient/Observation.read patient/Organization.read patient/Patient.read patient/Practitioner.read patient/Procedure.read patient/Provenance.read","refresh_token":"uw-4cwXncULPI5skwLhdIntJAVc8WeEvPpYcSZDj6PU","id_token":"eyJraWQiOiJ1Z09JUjBWSWNtVnBUejdzeFNPNmpzVk1LQXVPY3ZSOHVnY0ZsbUxMNXFRIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIwMHVibXVjem96bmFMcGFhVzI5NyIsInZlciI6MSwiaXNzIjoiaHR0cHM6Ly9hdGhlbmEub2t0YS5jb20vb2F1dGgyL2F1czJoZmY1ZXFGYjdXcWZoMjk3IiwiYXVkIjoiMG9hYXQxZHpkc3dFZ2JjSHkyOTciLCJpYXQiOjE2NTA1NTgxNDEsImV4cCI6MTY1MDU2MTc0MSwianRpIjoiSUQudmpRQmJ1N0U4b0tzUUtZMXg1bVNnczN2aVRISXdSeWNhclRHRTVYOFIxSSIsImFtciI6WyJwd2QiXSwiaWRwIjoiMDBvNnd6c2F2ZjdVNXpsNFMyOTYiLCJhdXRoX3RpbWUiOjE2NTA1NTgxMjIsImF0X2hhc2giOiJ0WEFFTTdKdF9zaC1rcE50d011cWlRIiwiZmhpclVzZXIiOiJodHRwczovL2FwaS5wbGF0Zm9ybS5hdGhlbmFoZWFsdGguY29tL2ZoaXIvcjQvUGF0aWVudC9hLTEyMy5FLTQ1Njc4OTAifQ.oSmOlQ41imNhulLhYUYAIXzu-nHukethXIuZNaOGrptCjKbcMzIghSo63tR_KW2ROgwgkQ_xhmrjo3NwoIt9eMSDArPb_zvM94RofP0SpcF5p0K-GedWC6HKEFFsB2rwoy9BZ5405Upp6MpY1Xd-nKxaxjXaiNjmwB2qIyt7LrhfZpbPHkYdnma88IYA7AQCIvHRcUZmQ4OK_6RTxIacsp54Rhuc2hcPpUNNKrTxgdCdfXmLhLtB_LlP2kAMKvNlC-MBsvHRrlDUvIhbjioFniY7gEkx1o7M1ezfqAQXwDwMmlbLuTO4ry48Oz4fkOHeGhb-VBoHHrkx-VMyI2K-ag","patient":"a-123.E-4567890"}
Use an Access Token as a Bearer Token
Your app must parse the token API response for the access token to include in the header of subsequent requests to API endpoints used to read, write, or update GlaceEMR data. For example:
curl 'https://auth.glaceemr.com/realms/fhir/protocol/openid-connect/token' \
-H'Authorization: Bearer {access_token}'
Refresh a Token
Due to the short-lived nature of access tokens, apps using 3-legged OAuth may want to request these tokens periodically without repeatedly requiring the end user (patient or provider) to log in and approve the request. This is possible using a refresh token, which is returned by the authorize endpoint when the offline_access scope is requested and obtained with the user's authorization. To get an access token from a refresh token, you will need to form a new token request providing the refresh token in the refresh_token parameter and refresh_token as the value for the grant_type parameter. Your app will also need to specify in the scope parameter which of the previously granted scopes your app would like included in the new access token. You can view which scopes were previously granted with an access token using introspection.
Authorize Endpoint
The OAuth authorize endpoint is used exclusively for 3-legged OAuth to request and obtain end user login and consent as a prerequisite to requesting an access token. The authorize endpoint temporarily redirects the end user, in which the user is asked to log in or automatically authenticated using an existing login session, prompted for consent (if applicable), and finally redirected back to the requesting app with an authorization code. The app then provides this authorization code to the token endpoint to obtain an access token.
The most common and secure patterns for end user authorization through the authorize endpoint are the Provider EHR SMART App Launch and Patient Standalone SMART App Launch sequences outlined by the SMART on FHIR specification, although other end user workflows are possible based on the OAuth scopes provided in the authorize request.
Launch a Provider-Facing App
Embedded apps launched from GlaceEMR must provide a launch URL to obtain OAuth client credentials. The launch URL will be hyperlinked in your app's launch space within GlaceEMR, such as the Apps section of the patient chart. When a provider clicks on this link, GlaceEMR will redirect to the launch URL with two appended query parameters per the Provider EHR SMART App Launch specification:
|
launch |
A unique identifier for the launch event. |
|
iss |
The FHIR resource issuer, which in this case is the base URL for GlaceEMR's FHIR API server (see FHIR API Locations and Metadata for details) |
Your app's launch URL should be configured to both:
- automatically form an authorize request upon redirect
- parse the redirect URL for the launch and iss parameters to include in the authorize request (see launch and aud parameters in Input Parameters below)
Input Parameters
* = required
|
client_id* |
string |
The value is your app's OAuth client ID. The client ID must be provisioned for the GlaceEMR environment specified in the base URL of the authorize endpoint. |
|
response_type* |
string |
The value is always code. |
|
redirect_uri* |
string |
The value is your app's post-login redirect URI where you will receive an authorization code. The redirect URI must exactly match a post-login redirect URI configured for your app's OAuth client credentials during registration. |
|
scope* |
string |
The value is a space-delimited, case-sensitive string of requested scopes. At minimum you must request the OpenID Connect workflow scope (openid) for successful authentication and to obtain an ID token in the token endpoint response. To obtain a refresh token in the token endpoint response, you must request the offline_access scope. To perform a SMART App Launch sequence, you must request either the launch or launch/patient scope (for provider EHR launch or patient standalone launch, respectively) in addition to resource-level scopes for those FHIR endpoints you will access through your app launch. |
|
aud |
string |
The value is the FHIR base URL, used to specify the organization for which the end user will be authenticated. The FHIR base URL may specify practice ID, department ID, brand ID, chart sharing group ID, or none of the above to indicate a global login. |
|
launch |
string |
Required to launch a provider-facing app from GlaceEMR. The value specifies a unique app launch event and must match the launch parameter appended to your app's launch URL by GlaceEMR. |
|
nonce |
string |
Required if requesting the openid scope. The value is a one-time use arbitrary string provided by your app and subsequently returned by token endpoint as a claim in the ID token. The intent of this parameter, per OAuth specification, is for your app to compare the provided nonce with the nonce claim in the ID token claim to help prevent replay attacks. |
|
state* |
string |
The value is a one-time use arbitrary string provided by your app and subsequently returned by the authorize endpoint. The intent of this parameter, per OAuth specification, is for your app to compare the request and response values to prevent cross-site request forgery attacks. |
|
code_challenge |
string |
Required for token authentication using PKCE if your app cannot securely store or does not have a client secret. The value is the transformation of a one-time use, unique string generated by your app, where the original string (code verifier) conforms to provided to the token endpoint. |
|
code_challenge_method |
string |
Required for token authentication using PKCE if your app cannot securely store or does not have a client secret. The value is the encryption method used to transform the code verifier into the code challenge (e.g., value is S256 if using SHA256 encryption). |
Response Parameters & Configure a Redirect URI
|
code |
string |
The value is an obscure authorization code generated by our authorization server and required to make a token request using 3-legged OAuth. |
|
state |
string |
The value is identical to the state parameter provided in your app's authorize request. |
To string together the authorize and token endpoint requests required for 3-legged OAuth, you will need to configure your app's redirect URI to accept GET requests from the authorize endpoint with the above parameters. Your redirect URI must parse the code parameter from the response to include with your token request.
Terms Of Use
In these API Terms of Use ("Terms") "GlaceEMR" refers to Glenwood Systems, LLC.'s ("GLENWOOD") Electronic Health Records product GlaceEMR and its ancillary software, and "HCO" refers to the Health Care Organization that has implemented the GlaceEMR API software. These Terms govern your access to and use of the GlaceEMR API. By accessing or using the GlaceEMR API, the App Developer ("You") or App User ("You"), agree to be bound by these Terms.
1. OFFICE OF THE NATIONAL COORDINATOR FOR HEALTH INFORMATION TECHNOLOGY ("ONC")
Pursuant to requirements set forth by the ONC for electronic health record ("EHR") software to meet in order to be certified EHR for the 2015 edition, GLENWOOD has made available the GlaceEMR API via this site to enable retrieval of patient information from the GlaceEMR EHR.
2. ACCEPTING THE TERMS
a. Legal Age
You represent and warrant that you are at least 18 years of age and that you possess the legal right and ability to agree to these Terms and to use the GlaceEMR API in accordance with these Terms.
b. Entity-Level Acceptance
If you are using the GlaceEMR API on behalf of an entity, you represent and warrant that you have authority to bind that entity to the Terms and by accepting the Terms, you are doing so on behalf of that entity (and all references to "you" in the Terms refer to that entity).
3. CHANGES
a. To GlaceEMR API
GLENWOOD may modify or update the GlaceEMR API from time to time. We will try to ensure, as far as possible, that future version(s) of the GlaceEMR API are backwards compatible with at least the most recent previous version but cannot guarantee that this will always be possible. You should adapt your app to use the most up-to-date version of the GlaceEMR API promptly following release by GLENWOOD.
b. To GlaceEMR API Terms of Use
GLENWOOD may change and update these Terms from time to time and will publish any changes on this page. Make sure to check this page for any updates. Your continued use of the API after any such changes constitutes your acceptance of the new terms. If you are unable to comply with any amended version of the Terms, you should stop use of the GlaceEMR API immediately.
4. RESPONSIBILITIES AND REPRESENTATIONS
a. Compliance
You agree to comply with all aspects of Health Insurance Portability and Accountability Act of 1996 (HIPAA), Health Information Technology for Economic and Clinical Health Act of 2009 (HITECH), Health and Human Services' (HHS) Omnibus Rule of 2013, all applicable local laws, all applicable state laws, all applicable federal laws, rules and regulations relating to the use of the GlaceEMR API.
b. Registration
You agree to register your app with an HCO that has implemented the GlaceEMR API. You represent and warrant that the registration information you provide to HCO is accurate.
c. App
You represent and warrant that your app is stable and secured.
d. Support
You agree to provide meaningful customer support for your app and to make it easy for customers to contact you with questions and concerns about your App.
e. Privacy Policy
You agree to provide and comply with a publicly accessible privacy policy.
5. HEALTH CARE ORGANIZATION
The HCO with which you register your app may provide its own Terms of Use ("HCO Terms"). You agree to adhere to the HCO Terms. In the event of a conflict between these Terms and the HCO Terms, the HCO Terms will control.
6. GlaceEMR API RESTRICTIONS
When using the GlaceEMR API, you may not (or allow those acting on your behalf to):
- Sell, lease or sublicense the GlaceEMR API or any data derived through the GlaceEMR API.
- Reverse engineer or attempt to extract the source code from any API or any related software, except to the extent that this restriction is expressly prohibited by applicable law.
- Perform an Action with the intent of introducing to the GlaceEMR API any viruses, defects, malware, or any items of a destructive nature.
- Interfere with or disrupt the GlaceEMR API or the servers or networks providing the GlaceEMR API.
7. GlaceEMR API LIMITATIONS
GLENWOOD sets and enforces limits on your use of the GlaceEMR API, in our sole discretion, without notice or liability. GLENWOOD reserves the right to:
- Rate limit or block apps that make a large number of calls to the GlaceEMR API
- Disable, restrict or remove your app's access to the GlaceEMR API
- Change, suspend, or discontinue the availability of the GlaceEMR API at any time
- Impose limits on certain features or restrict your access to parts or all of the GlaceEMR API
8. IP OWNERSHIP
GLENWOOD retains ownership of GLENWOOD's property and reserves all of its applicable rights with respect to the content of this site, the GlaceEMR EHR, and the GlaceEMR API. Nothing in these Terms shall convey any transfer of ownership of GLENWOOD's property.
9. INDEMNIFICATION
YOU AGREE TO INDEMNIFY, DEFEND AND HOLD HARMLESS GLENWOOD, ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, AFFILIATES, INFORMATION PROVIDERS AND SUPPLIERS FROM AND AGAINST ALL CLAIMS, LIABILITIES, LOSSES, EXPENSES, DAMAGES AND COSTS, INCLUDING REASONABLE ATTORNEYS' FEES ("CLAIMS"), RESULTING FROM ANY VIOLATION OF THESE TERMS OR ANY CLAIMS ARISING FROM YOUR USE OF THE GlaceEMR API OR THE GLENWOOD WEB SITE, GlaceEMR WEBSITES (INCLUDING BUT NOT LIMITED TO INFRINGEMENT OF THIRD PARTIES' INTELLECTUAL PROPERTY RIGHTS, MISAPPROPRIATION OF TRADE SECRETS OR OTHER PROPRIETARY RIGHTS OR NEGLIGENT OR WRONGFUL CONDUCT).
10. DISCLAIMERS
THIS SITE AND THE GlaceEMR API ARE PROVIDED ON AN "AS IS" AND "AS AVAILABLE" BASIS. YOU EXPRESSLY AGREE THAT USE OF THIS SITE AND/OR THE GlaceEMR API IS AT YOUR SOLE RISK. TO THE FULLEST EXTENT PERMITTED BY LAW, GLENWOOD AND ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, AFFILIATES, INFORMATION PROVIDERS AND SUPPLIERS DISCLAIM ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, OR NON-INFRINGEMENT. GLENWOOD MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY, RELIABILITY, AVAILABILITY, AND ACCURACY OF THE GlaceEMR API OR OTHER INFORMATION, TECHNOLOGY, SOFTWARE, PRODUCTS, SERVICES AND RELATED GRAPHICS PROVIDED BY GLENWOOD FOR ANY PURPOSE.
11. LIMITATION OF LIABILITY
TO THE FULLEST EXTENT PERMITTED BY LAW, UNDER NO CIRCUMSTANCES, SHALL GLENWOOD, ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, AFFILIATES, INFORMATION PROVIDERS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY DIRECT, INDIRECT, PUNITIVE, INCIDENTAL, SPECIAL, CONSEQUENTIAL DAMAGES OR ANY OTHER DAMAGES WHATSOEVER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF USE, DATA OR PROFITS, ARISING OUT OF OR IN ANY WAY CONNECTED WITH THE ACCESS, USE OR PERFORMANCE OF THE GlaceEMR API, WITH THE DELAY OR INABILITY TO USE THE GlaceEMR API OR RELATED TECHNOLOGY, SOFTWARE OR SERVICES, THE PROVISION OF OR FAILURE TO PROVIDE THE GlaceEMR API, SOFTWARE OR SERVICES, OR FOR ANY INFORMATION, SOFTWARE, PRODUCTS, SERVICES AND RELATED GRAPHICS OBTAINED FROM GLENWOOD, OR OTHERWISE ARISING OUT OF THE USE OF THE GlaceEMR API, WHETHER BASED ON CONTRACT, TORT, NEGLIGENCE, STRICT LIABILITY OR OTHERWISE, EVEN IF GLENWOOD HAS BEEN ADVISED OF THE POSSIBILITY OF DAMAGES. IF YOU ARE DISSATISFIED WITH ANY PORTION OF THE GlaceEMR API OR WITH THESE TERMS OF USE, YOUR SOLE AND EXCLUSIVE REMEDY IS TO DISCONTINUE USING THE GlaceEMR API. NOTWITHSTANDING THE FOREGOING PARAGRAPH, THE TOTAL LIABILITY OF GLENWOOD, ITS OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, AFFILIATES,INFORMATION PROVIDERS AND/OR SUPPLIERS, IF ANY, FOR LOSSES OR DAMAGES SHALL NOT EXCEED THE FEES PAID BY YOU FOR THE USE OF THE PARTICULAR TECHNOLOGY, SOFTWARE, PRODUCT, INFORMATION OR SERVICE PROVIDED BY GLENWOOD.
12. THIRD PARTY CONTENT
The GlaceEMR API may contain software, materials, content, data, or information provided, posted, or offered by third parties. You agree that neither GLENWOOD nor its affiliates shall have any liability whatsoever to you for any such third-party software, materials, content, data, or information.
13. TERM AND TERMINATION
Either you, GLENWOOD or the HCO may terminate your right to use the GlaceEMR API at any time, with or without cause or notice.
14. PUBLICITY
You will not make any statement regarding your use of the GlaceEMR API which suggests a partnership with, sponsorship by, or endorsement by GLENWOOD without GLENWOOD's written approval.
15. APPLICABLE LAW
These Terms shall be governed by and construed in accordance with the laws of the State of Connecticut. Any and all claims arising out of or relating to these Terms shall be brought in a state or federal court of competent jurisdiction in the State of Connecticut. You consent to the personal and subject matter jurisdiction of the state and/or federal courts located in the State of Connecticut and waive (a) any objection to jurisdiction or venue, or (b) any defense claiming lack of jurisdiction or improper venue, in any action brought in such courts.
Allergy or Intolerance
Definition : Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance.
Retrieving a patient's allergy intolerances
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
AllergyIntolerance
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external ids for this item |
| clinicalStatus | CodeableConcept | 0..1 | active |
| verificationStatus | CodeableConcept | 1..1 | unconfirmed |
| type | code | 0..1 | allergy |
| category | code | 0..* | food |
| criticality | code | 0..1 | low |
| code | CodeableConcept | 1..1 | code that identifies the allergy or intolerance - ValueSet |
| patient | Reference | 1..1 | who the sensitivity is for |
| encounter | Reference | 0..1 | encounter when the allergy or intolerance was asserted. When allergy or intolerance was identified |
| onsetDateTime | dateTime | 0..1 | when allergy or intolerance was identified |
| onsetAge | Age | 0..1 | when allergy or intolerance was identified |
| onsetPeriod | Period | 0..1 | when allergy or intolerance was identified |
| onsetRange | Range | 0..1 | when allergy or intolerance was identified |
| onsetString | string | 0..1 | when allergy or intolerance was identified |
| recordedDate | dateTime | 0..1 | date first version of the resource instance was recorded |
| recorder | Reference | 0..1 | who recorded the sensitivity |
| asserter | Reference | 0..1 | source of the information about the allergy |
| lastOccurrence | dateTime | 0..1 | date(/time) of last known occurrence of a reaction |
| note | Annotation | 0..* | additional text not captured in other fields |
| reaction | BackboneElement | 0..* | adverse Reaction Events linked to exposure to substance |
| reaction.manifestation | CodeableConcept | 1..* | ValueSet |
Search Parameters
| Name | Type | Description |
|---|---|---|
| severity | token | mild |
| date | date | date record was believed accurate |
| manifestation | token | clinical symptoms/signs associated with the Event |
| recorder | reference | who recorded the sensitivity |
| code | token | code that identifies the allergy or intolerance |
| verification-status | token | unconfirmed |
| clinical-status | token | active |
| patient | reference | who the sensitivity is for |
| _include | AllergyIntolerance:recorder | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
AllergyIntolerance
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "AllergyIntolerance",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "300913006",
"display": "Shellfish allergy"
}
],
"text": "Shellfish allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "c6819f53-10bf-4615-b0af-5ee5b8f7f1ae",
"meta": {
"lastUpdated": "2022-11-04T16:03:39.913+00:00"
},
"type": "searchset",
"total": 10,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance?patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/{{ResourceId}}",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "300913006",
"display": "Shellfish allergy"
}
],
"text": "Shellfish allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/389",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "389",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "418689008",
"display": "Allergy to grass pollen"
}
],
"text": "Allergy to grass pollen"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/394",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "394",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "91935009",
"display": "Allergy to peanuts"
}
],
"text": "Allergy to peanuts"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/391",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "391",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "inactive"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "714035009",
"display": "Allergy to soya"
}
],
"text": "Allergy to soya"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/386",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "386",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "419474003",
"display": "Allergy to mould"
}
],
"text": "Allergy to mould"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/385",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "385",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "inactive"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "300916003",
"display": "Latex allergy"
}
],
"text": "Latex allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00",
"reaction": [
{
"manifestation": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "271807003",
"display": "skin rash"
}
],
"text": "skin rash"
}
]
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/387",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "387",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "232350006",
"display": "House dust mite allergy"
}
],
"text": "House dust mite allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/390",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "390",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "419263009",
"display": "Allergy to tree pollen"
}
],
"text": "Allergy to tree pollen"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/388",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "388",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "232347008",
"display": "Dander (animal) allergy"
}
],
"text": "Dander (animal) allergy"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/AllergyIntolerance/393",
"resource": {
"resourceType": "AllergyIntolerance",
"id": "393",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification",
"code": "confirmed"
}
]
},
"type": "allergy",
"category": [
"food"
],
"criticality": "low",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "417532002",
"display": "Allergy to fish"
}
],
"text": "Allergy to fish"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"recordedDate": "1941-10-14T18:33:18-05:00"
},
"search": {
"mode": "match"
}
}
]
}Care Team
Definition : The Care Team includes all the people and organizations who plan to participate in the coordination and delivery of care for a patient.
Retrieving a patient's care team(s)
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Ids for this team |
| status | code | 1..1 | proposed |
| category | CodeableConcept | 0..* | type of team |
| name | string | 0..1 | name of the team, such as the crisis assessment team |
| subject | ResourceReference | 1..1 | who care team is for |
| period | Period | 0..1 | time period team covers |
| participant | CareTeam.Participant | 1..* | members of the team |
| participant.role | CodeableConcept | 1..1 | type of involvement - Binding |
| participant.member | Reference(US Core Patient Profile | US Core Practitioner Profile | 1..1 |
| managingOrganization | ResourceReference | 0..1 | organization responsible for the care team |
| encounter | ResourceReference | 0..1 | encounter created as part of |
| reasonCode | CodeableConcept | 0..* | time period of participant |
Search Parameters
| Name | Type | Description |
|---|---|---|
| category | token | |
| date | date | |
| encounter | reference | |
| identifier | token | |
| participant | reference | |
| patient | reference | |
| status | token | |
| subject | reference | |
| _revinclude | Provenance:target |
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
CareTeam
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CareTeam
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CareTeam/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "CareTeam",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "116154003",
"display": "Patient"
}
],
"text": "Patient"
}
],
"member": {
"reference": "Patient/{{PPG}}",
"display": "Mr. Lucien408 Bosco882"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "223366009",
"display": "Healthcare professional (occupation)"
}
],
"text": "Healthcare professional (occupation)"
}
],
"member": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "224891009",
"display": "Healthcare services (qualifier value)"
}
],
"text": "Healthcare services (qualifier value)"
}
],
"member": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
}
],
"managingOrganization": [
{
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
]
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CareTeam?patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "2482059a-4266-4ecf-b55b-ea36dbd9c134",
"meta": {
"lastUpdated": "2022-11-04T16:03:15.410+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CareTeam?patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CareTeam/{{ResourceId}}",
"resource": {
"resourceType": "CareTeam",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careteam"
]
},
"status": "active",
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"participant": [
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "116154003",
"display": "Patient"
}
],
"text": "Patient"
}
],
"member": {
"reference": "Patient/{{PPG}}",
"display": "Mr. Lucien408 Bosco882"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "223366009",
"display": "Healthcare professional (occupation)"
}
],
"text": "Healthcare professional (occupation)"
}
],
"member": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
},
{
"role": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "224891009",
"display": "Healthcare services (qualifier value)"
}
],
"text": "Healthcare services (qualifier value)"
}
],
"member": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
}
],
"reasonCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
}
],
"managingOrganization": [
{
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
}
]
},
"search": {
"mode": "match"
}
}
]
}Plan of Care
Definition : A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "Plan of Care" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score.
Retrieving a patient's Clinical Impression
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | |
| subject | ResourceReference | 0..1 | |
| status | string | 1..1 | draft |
| period | Period | 0..1 | |
| modified | dateTime | 0..1 | |
| addresses | ResourceReference | 0..* | |
| careTeam | CarePlan.Participant | 0..* | |
| goal | ResourceReference | 0..* | |
| activity | CarePlan.Activity | 0..* | |
| notes | string | 0..1 | |
| category | CodeableConcept | 1..* | type of plan - always has at least one coding with system=http://hl7.org/fhir/us/core/CodeSystem/careplan-category, code=assess-plan |
| encounter | ResourceReference | 0..1 | |
| intent | code | 1..1 | proposal |
| text | Narrative | 1..1 | |
| text.status | code | 1..1 | generated |
Search Parameters
| Name | Type | Description |
|---|---|---|
| activity-code | token | |
| activity-date | date | |
| activity-reference | reference | |
| based-on | reference | |
| care-team | reference | |
| category | token | |
| condition | reference | |
| date | date | |
| encounter | reference | |
| goal | reference | |
| identifier | token | |
| intent | token | |
| part-of | reference | |
| patient | reference | |
| performer | reference | |
| replaces | reference | |
| status | token | |
| subject | reference | |
| _revinclude | Provenance:target |
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
CarePlan
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "CarePlan",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture of clavicle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/145"
},
"period": {
"start": "1946-11-23T01:11:45-05:00",
"end": "1947-01-22T01:11:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/148"
}
],
"addresses": [
{
"reference": "Condition/146"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408580007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan?category=assess-plan&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "f410b714-bc58-467c-b4fb-21b3f00888e9",
"meta": {
"lastUpdated": "2022-11-04T16:03:14.807+00:00"
},
"type": "searchset",
"total": 6,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan?category=assess-plan&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/{{ResourceId}}",
"resource": {
"resourceType": "CarePlan",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Fracture care.<br/>Activities: <ul><li>Fracture care</li><li>Fracture care</li></ul><br/>Care plan is meant to treat Fracture of clavicle.</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385691007",
"display": "Fracture care"
}
],
"text": "Fracture care"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/145"
},
"period": {
"start": "1946-11-23T01:11:45-05:00",
"end": "1947-01-22T01:11:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/148"
}
],
"addresses": [
{
"reference": "Condition/146"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183051005",
"display": "Recommendation to rest"
}
],
"text": "Recommendation to rest"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "408580007",
"display": "Physical activity target light exercise"
}
],
"text": "Physical activity target light exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/211",
"resource": {
"resourceType": "CarePlan",
"id": "211",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/207"
},
"period": {
"start": "1958-12-21T00:11:45-05:00",
"end": "1959-05-29T01:11:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/210"
}
],
"addresses": [
{
"reference": "Condition/208"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/307",
"resource": {
"resourceType": "CarePlan",
"id": "307",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Inpatient care plan (record artifact).<br/>Activities: <ul><li>Inpatient care plan (record artifact)</li><li>Inpatient care plan (record artifact)</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736353004",
"display": "Inpatient care plan (record artifact)"
}
],
"text": "Inpatient care plan (record artifact)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/301"
},
"period": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-30T03:17:45-05:00"
},
"careTeam": [
{
"reference": "CareTeam/306"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385715006",
"display": "Cardiac care (regime/therapy)"
}
],
"text": "Cardiac care (regime/therapy)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386619000",
"display": "Low sodium diet (finding)"
}
],
"text": "Low sodium diet (finding)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/284",
"resource": {
"resourceType": "CarePlan",
"id": "284",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Inpatient care plan (record artifact).<br/>Activities: <ul><li>Inpatient care plan (record artifact)</li><li>Inpatient care plan (record artifact)</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "736353004",
"display": "Inpatient care plan (record artifact)"
}
],
"text": "Inpatient care plan (record artifact)"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"period": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-08T03:25:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/283"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "385715006",
"display": "Cardiac care (regime/therapy)"
}
],
"text": "Cardiac care (regime/therapy)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "386619000",
"display": "Low sodium diet (finding)"
}
],
"text": "Low sodium diet (finding)"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/235",
"resource": {
"resourceType": "CarePlan",
"id": "235",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Respiratory therapy.<br/>Activities: <ul><li>Respiratory therapy</li><li>Respiratory therapy</li></ul><br/>Care plan is meant to treat Acute bronchitis (disorder).</div>"
},
"status": "completed",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "53950000",
"display": "Respiratory therapy"
}
],
"text": "Respiratory therapy"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/231"
},
"period": {
"start": "1964-02-03T00:17:45-05:00",
"end": "1965-06-04T01:11:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/234"
}
],
"addresses": [
{
"reference": "Condition/208"
},
{
"reference": "Condition/232"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "304510005",
"display": "Recommendation to avoid exercise"
}
],
"text": "Recommendation to avoid exercise"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "371605008",
"display": "Deep breathing and coughing exercises"
}
],
"text": "Deep breathing and coughing exercises"
},
"status": "completed",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/CarePlan/267",
"resource": {
"resourceType": "CarePlan",
"id": "267",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Care Plan for Heart failure self management plan.<br/>Activities: <ul><li>Heart failure self management plan</li><li>Heart failure self management plan</li></ul><br/>Care plan is meant to treat Chronic congestive heart failure (disorder).</div>"
},
"status": "active",
"intent": "order",
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category",
"code": "assess-plan"
}
]
},
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "735984001",
"display": "Heart failure self management plan"
}
],
"text": "Heart failure self management plan"
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/263"
},
"period": {
"start": "1974-04-12T02:42:45-04:00"
},
"careTeam": [
{
"reference": "CareTeam/266"
}
],
"addresses": [
{
"reference": "Condition/260"
}
],
"activity": [
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183063000",
"display": "low salt diet education"
}
],
"text": "low salt diet education"
},
"status": "in-progress",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
},
{
"detail": {
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "183301007",
"display": "physical exercise"
}
],
"text": "physical exercise"
},
"status": "in-progress",
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
}
]
},
"search": {
"mode": "match"
}
}
]
}Diagnostic Order
Definition : A record of a request for a diagnostic investigation service to be performed.
Retrieving a patient's laboratory result diagnostic orders
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/diagnosticsorder/patientid/123/account/glace?access_token={access_token}
| Name | Type | Default Value | Description |
|---|---|---|---|
| Patient Id * | Integer - URL parameter | - | Account specific ID of the patient, retrieved from Centralized Patient Database |
| Account Id * | String - URL parameter | - | Logical Id of the account where Patient registered, retrieved from Centralized Patient Database |
| From Date | String - Request parameter (MM-DD-YYYY) |
- | Starting date of the date range period. To search for a specific date only mention the From date and do not mention End date. |
| End Date | String - Request parameter (MM-DD-YYYY) |
- | Ending date of the date range period |
| Resource ID* | String - Request parameter | - | Issued by the authorization server to the client to access FHIR APIs. |
Note : * parameters are required.
A DAF DiagnosticOrder is returned.
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
| item | 0..* | The specific diagnostic investigations that are requested as part of this request. Sometimes, there can only be one item per request, but in most contexts, more than one investigation can be requested. | |
| - item.code | CodeableConcept | 1..1 | A code that identifies a particular diagnostic investigation, or panel of investigations, that have been requested. |
| - item.status | code | 0..1 | The status of this individual item within the order. |
| subject | Reference ( Patient | Group | Device | Location ) | 1..1 | Who or what the investigation is to be performed on. This is usually a human patient, but diagnostic tests can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
| status | code | 0..1 | The status of the order. |
For more information on this resource, see http://hl7.org/fhir/R4/diagnosticorder.html
Response JSON Contains following information
Note : All API responses will be in the form on JSONArray or JSONObject. If the Patient exists in more the one account, all the response objects will be bundled into one.
{
"glace": [
{
"identifier": [
{
"system": "urn:oid:2.16.840.1.113883.3.225",
"use": "usual",
"id": "123",
"value": "123"
}
],
"item": [
{
"code": {
"coding": [
{
"display": "Snellen"
}
],
"text": "Snellen"
},
"status": "received"
}
],
"subject": {
"reference": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/patient/patientid/123/account/glace?access_token={access_token}",
"display": "TEST ASSOCIATE"
},
"event": [
{
"dateTime": "2017-07-18T00:00:00+05:30"
}
],
"resourceType": "DiagnosticOrder",
"status": "received"
}
]
}
Encounter
Definition : An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.
Retrieving a patient's encounters
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | identifier(s) by which this encounter is known |
| status | code | 1..1 | planned |
| statusHistory | BackboneElement | 0..* | list of past encounter statuses |
| class | Coding | 1..1 | inpatient |
| classHistory | BackboneElement | 0..* | list of past encounter classes |
| type | CodeableConcept | 1..* | specific type of encounter - Binding |
| serviceType | CodeableConcept | 0..1 | specific type of service |
| priority | CodeableConcept | 0..1 | indicates the urgency of the encounter |
| subject | Reference(US Core Patient Profile) | 1..1 | the patient or group present at the encounter |
| episodeOfCare | Reference | 0..* | episode(s) of care that this encounter should be recorded against |
| basedOn | Reference | 0..* | the ServiceRequest that initiated this encounter |
| participant | BackboneElement | 0..* | list of participants involved in the encounter |
| appointment | Reference | 0..* | the appointment that scheduled this encounter |
| period | Period | 0..1 | the start and end time of the encounter |
| length | Duration | 0..1 | quantity of time the encounter lasted (less time absent) |
| reasonCode | CodeableConcept | 0..* | coded reason the encounter takes place |
| reasonReference | Reference | 0..* | reason the encounter takes place (reference) |
| diagnosis | BackboneElement | 0..* | the list of diagnoses relevant to this encounter |
| account | Reference | 0..* | the set of accounts that may be used for billing for this Encounter |
| hospitalization | BackboneElement | 0..1 | details about the admission to a healthcare service |
| hospitalization.dischargeDisposition | CodeableConcept | 0..1 | category or kind of location after discharge |
| location | BackboneElement | 0..* | list of locations where the patient has been |
| location.location | Location | 1..1 | location the encounter takes place |
| serviceProvider | Reference | 0..1 | the custodian organization of this Encounter record |
| partOf | Reference | 0..1 | another encounter this encounter is part of |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | a date within the period the Encounter lasted |
| identifier | token | identifier(s) by which this encounter is known |
| episodeofcare | reference | episode(s) of care that this encounter should be recorded against |
| participant-type | token | role of participant in encounter |
| practitioner | reference | persons involved in the encounter other than the patient |
| subject | reference | the patient or group present at the encounter |
| length | number | length of encounter in days |
| diagnosis | reference | reason the encounter takes place (resource) |
| appointment | reference | the appointment that scheduled this encounter |
| participant | reference | persons involved in the encounter other than the patient |
| patient | reference | the patient or group present at the encounter |
| location-period | date | time period during which the patient was present at the location |
| location | reference | location the encounter takes place |
| service-provider | reference | the custodian organization of this encounter record |
| class | token | inpatient |
| status | token | planned |
| service-type | token | |
| _include | Encounter:episodeofcare | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Encounter
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Encounter
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Encounter/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Encounter",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter"
]
},
"identifier": [
{
"use": "official",
"system": "https://github.com/synthetichealth/synthea",
"value": "f3a71d9a-67bd-756f-2de7-db59e6788457"
}
],
"status": "finished",
"class": {
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "AMB"
},
"type": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "162673000",
"display": "General examination of patient (procedure)"
}
],
"text": "General examination of patient (procedure)"
}
],
"subject": {
"reference": "Patient/{{PPG}}",
"display": "Mr. Lucien408 Bosco882"
},
"participant": [
{
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PPRF",
"display": "primary performer"
}
],
"text": "primary performer"
}
],
"period": {
"start": "1958-05-23T01:11:45-04:00",
"end": "1958-05-23T01:26:45-04:00"
},
"individual": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
}
],
"period": {
"start": "1958-05-23T01:11:45-04:00",
"end": "1958-05-23T01:26:45-04:00"
},
"location": [
{
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
}
],
"serviceProvider": {
"reference": "Organization/87",
"display": "PCP87052"
}
}Goals
Definition : Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.
Retrieving a patient's goals
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Ids for this goal |
| lifecycleStatus | code | 1..1 | proposed |
| achievementStatus | code | 0..1 | in-progress |
| category | CodeableConcept | 0..* | e.g. Treatment, dietary, behavioral, etc. |
| priority | CodeableConcept | 0..1 | high-priority |
| description | CodeableConcept | 1..1 | code or text describing goal |
| subject | Reference(US Core Patient Profile) | 1..1 | who this goal is intended for |
| startDate | date | 0..1 | when goal pursuit begins |
| startCodeableConcept | CodeableConcept | 0..1 | when goal pursuit begins |
| target | BackboneElement | 0..* | target outcome for the goal |
| target.dueDate | date | 0..1 | reach goal on or before |
| statusDate | date | 0..1 | when goal status took effect |
| statusReason | string | 0..1 | reason for current status |
| expressedBy | Reference | 0..1 | who's responsible for creating Goal |
| addresses | Reference | 0..* | issues addressed by this goal |
| note | Annotation | 0..* | comments about the goal |
| outcomeCode | CodeableConcept | 0..* | what result was achieved regarding the goal |
| outcomeReference | Reference | 0..* | observation that resulted from goal |
Search Parameters
| Name | Type | Description |
|---|---|---|
| patient | reference | who this goal is intended for |
| subject | reference | who this goal is intended for |
| start-date | date | when goal pursuit begins |
| category | token | e.g. treatment, dietary, behavioral, etc. |
| lifecycleStatus | token | proposed |
| achievementStatus | token | in-progress |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Goal
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Goal
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Goal/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Goal",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"
]
},
"lifecycleStatus": "active",
"description": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "281004",
"display": "Alcoholic dementia"
}
],
"text": "Alcoholic dementia"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"target": [
{
"dueDate": "2020-12-07"
}
]
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Goal?patient={{PPG}}&_revinclude=Provenance:target
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "07aa2339-685b-47d0-8053-10ea1c1f5460",
"meta": {
"lastUpdated": "2022-11-04T16:03:21.867+00:00"
},
"type": "searchset",
"total": 0,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Goal?_revinclude=Provenance%3Atarget&patient={{PPG}}"
}
]
}Health Concerns
Definition : Use to record detailed information about conditions, problems or diagnoses recognized by a clinician like recording a problem, diagnosis, health concern or health issue during an encounter
Retrieving a patient's health concerns
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Condition
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Ids for this condition |
| clinicalStatus | CodeableConcept | 0..1 | active |
| verificationStatus | CodeableConcept | 0..1 | provisional |
| category | CodeableConcept | 1..* | problem-list-item |
| encounter | Reference | 0..1 | encounter created as part of |
| severity | CodeableConcept | 0..1 | subjective severity of condition |
| code | CodeableConcept | 1..1 | identification of the condition, problem or diagnosis - Binding |
| bodySite | CodeableConcept | 0..* | anatomical location, if relevant |
| subject | Reference(US Core Patient Profile) | 1..1 | who has the condition |
| onsetDateTime | dateTime | 0..1 | estimated or actual date, date-time, or age |
| onsetAge | Age | 0..1 | estimated or actual date, date-time, or age |
| onsetPeriod | Period | 0..1 | estimated or actual date, date-time, or age |
| onsetRange | Range | 0..1 | estimated or actual date, date-time, or age |
| onsetString | string | 0..1 | estimated or actual date, date-time, or age |
| abatementDateTime | dateTime | 0..1 | if/when in resolution/remission |
| abatementAge | Age | 0..1 | if/when in resolution/remission |
| abatementPeriod | Period | 0..1 | if/when in resolution/remission |
| abatementRange | Range | 0..1 | if/when in resolution/remission |
| abatementString | string | 0..1 | if/when in resolution/remission |
| recordedDate | dateTime | 0..1 | date record was believed accurate |
| recorder | Reference | 0..1 | person who asserts this condition |
| asserter | Reference | 0..1 | person who asserts this condition |
| stage | BackboneElement | 0..* | stage/grade, usually assessed formally |
| evidence | BackboneElement | 0..* | supporting evidence |
| note | Annotation | 0..* | additional information about the Condition |
Search Parameters
| Name | Type | Description |
|---|---|---|
| severity | token | the severity of the condition |
| code | token | code for the condition |
| evidence | token | manifestation/symptom |
| subject | reference | who has the condition |
| clinical-status | token | the clinical status of the condition |
| encounter | reference | encounter when condition first asserted |
| abatement-boolean | token | abatement boolean (boolean is true or non-boolean values are present) |
| onset-date | date | date related onsets (dateTime and Period) |
| abatement-date | date | date-related abatements (dateTime and period) |
| asserter | reference | person who asserts this condition |
| stage | token | simple summary (disease specific) |
| patient | reference | who has the condition |
| context | reference | encounter or episode when condition first asserted |
| recorded-date | date | date record was believed accurate |
| category | token | the category of the condition |
| _include | undefined | condition:subject |
| _revinclude | provenance:target |
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Condition
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/259"
},
"onsetDateTime": "1974-03-29T01:11:45-04:00",
"recordedDate": "1974-03-29T01:11:45-04:00"
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "9c1f35ee-29fb-4b25-8436-1d8f89e603da",
"meta": {
"lastUpdated": "2022-11-04T16:03:16.261+00:00"
},
"type": "searchset",
"total": 13,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition?patient={{PPG}}"
},
{
"relation": "next",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}?_getpages=9c1f35ee-29fb-4b25-8436-1d8f89e603da&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/{{ResourceId}}",
"resource": {
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/259"
},
"onsetDateTime": "1974-03-29T01:11:45-04:00",
"recordedDate": "1974-03-29T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/220",
"resource": {
"resourceType": "Condition",
"id": "220",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/219"
},
"onsetDateTime": "1961-06-25T01:11:45-04:00",
"abatementDateTime": "1961-07-07T01:11:45-04:00",
"recordedDate": "1961-06-25T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/111",
"resource": {
"resourceType": "Condition",
"id": "111",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/110"
},
"onsetDateTime": "1941-01-26T00:11:45-05:00",
"abatementDateTime": "1941-02-06T00:11:45-05:00",
"recordedDate": "1941-01-26T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/208",
"resource": {
"resourceType": "Condition",
"id": "208",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "10509002",
"display": "Acute bronchitis (disorder)"
}
],
"text": "Acute bronchitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/207"
},
"onsetDateTime": "1958-12-21T00:11:45-05:00",
"abatementDateTime": "1958-12-28T00:11:45-05:00",
"recordedDate": "1958-12-21T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/176",
"resource": {
"resourceType": "Condition",
"id": "176",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "444814009",
"display": "Viral sinusitis (disorder)"
}
],
"text": "Viral sinusitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/175"
},
"onsetDateTime": "1951-09-04T01:11:45-04:00",
"abatementDateTime": "1951-09-18T01:11:45-04:00",
"recordedDate": "1951-09-04T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/251",
"resource": {
"resourceType": "Condition",
"id": "251",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/250"
},
"onsetDateTime": "1969-10-08T01:11:45-04:00",
"abatementDateTime": "1969-10-15T01:11:45-04:00",
"recordedDate": "1969-10-08T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/158",
"resource": {
"resourceType": "Condition",
"id": "158",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "65363002",
"display": "Otitis media"
}
],
"text": "Otitis media"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/157"
},
"onsetDateTime": "1947-11-01T00:11:45-05:00",
"abatementDateTime": "1948-03-26T00:11:45-05:00",
"recordedDate": "1947-11-01T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/249",
"resource": {
"resourceType": "Condition",
"id": "249",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "444814009",
"display": "Viral sinusitis (disorder)"
}
],
"text": "Viral sinusitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/248"
},
"onsetDateTime": "1969-06-22T01:11:45-04:00",
"abatementDateTime": "1969-07-06T01:11:45-04:00",
"recordedDate": "1969-06-22T01:11:45-04:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/258",
"resource": {
"resourceType": "Condition",
"id": "258",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "195662009",
"display": "Acute viral pharyngitis (disorder)"
}
],
"text": "Acute viral pharyngitis (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/257"
},
"onsetDateTime": "1972-03-05T00:11:45-05:00",
"abatementDateTime": "1972-03-13T00:11:45-05:00",
"recordedDate": "1972-03-05T00:11:45-05:00"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/108",
"resource": {
"resourceType": "Condition",
"id": "108",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "65363002",
"display": "Otitis media"
}
],
"text": "Otitis media"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/107"
},
"onsetDateTime": "1940-12-24T00:11:45-05:00",
"abatementDateTime": "1941-03-07T00:11:45-05:00",
"recordedDate": "1940-12-24T00:11:45-05:00"
},
"search": {
"mode": "match"
}
}
]
}Immunization
Definition : Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.
Retrieving a patient's immunizations
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | business identifier |
| status | code | 1..1 | completed |
| statusReason | boolean | 0..1 | reason not done - Binding |
| vaccineCode | CodeableConcept | 1..1 | vaccine product administered - Binding |
| patient | Reference(US Core Patient Profile) | 1..1 | who was immunized |
| encounter | Reference | 0..1 | encounter immunization was part of |
| occurrenceDateTime | dateTime | 1..1 | vaccination administration date - either occurenceDateTime or occurenceString must be set |
| occurrenceString | string | 1..1 | vaccination administration date - either occurenceDateTime or occurenceString must be set |
| recorded | dateTime | 0..1 | when the immunization was first captured in the subject's record |
| primarySource | boolean | 1..1 | indicates context the data was recorded in |
| reportOrigin | CodeableConcept | 0..1 | indicates the source of a secondarily reported record |
| location | Reference | 0..1 | where vaccination occurred |
| manufacturer | Reference | 0..1 | vaccine manufacturer |
| lotNumber | string | 0..1 | vaccine lot number |
| expirationDate | date | 0..1 | vaccine expiration date |
| site | CodeableConcept | 0..1 | body site vaccine was administered |
| route | CodeableConcept | 0..1 | how vaccine entered body |
| doseQuantity | Quantity | 0..1 | amount of vaccine administered |
| performer | BackboneElement | 0..* | who performed event |
| note | Annotation | 0..* | additional immunization notes |
| reasonCode | CodeableConcept | 0..* | why immunization occurred |
| reasonReference | Reference | 0..* | why immunization occurred |
| isSubpotent | boolean | 0..1 | dose potency |
| subpotentReason | CodeableConcept | 0..* | reason for being subpotent |
| education | BackboneElement | 0..1 | educational material presented to patient + Rule: One of documentType or reference SHALL be present |
| programEligibility | CodeableConcept | 0..* | patient eligibility for a vaccination program |
| fundingSource | CodeableConcept | 0..* | funding source for the vaccine |
| reaction | BackboneElement | 0..* | details of a reaction that follows immunization |
| protocolApplied | BackboneElement | 0..* | protocol followed by the provider |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | vaccination (non)-Administration Date |
| identifier | token | business identifier |
| location | reference | the service delivery location or facility in which the vaccine was/was to be administered |
| lot-number | string | vaccine Lot Number |
| manufacturer | reference | vaccine Manufacturer |
| patient | reference | the patient for the vaccination record |
| performer | reference | the practitioner who played a role in the vaccination |
| reaction | reference | additional information on reaction |
| reaction-date | date | when reaction started |
| reason-code | token | reason why the vaccine was administered |
| reason-reference | reference | why immunization occurred |
| series | string | the series being followed by the provider |
| status | token | immunization event status |
| status-reason | token | reason why the vaccine was not administered |
| target-disease | token | the target disease the dose is being administered against |
| vaccine-code | token | vaccine product administered |
| _include | undefined | immunization:manufacturer |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Immunization
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Immunization",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/169"
},
"occurrenceDateTime": "1950-04-07T00:11:45-05:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "199f12b2-1b90-4283-8ee5-1ac95d34ee9b",
"meta": {
"lastUpdated": "2022-11-04T16:03:21.977+00:00"
},
"type": "searchset",
"total": 20,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization?patient={{PPG}}"
},
{
"relation": "next",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}?_getpages=199f12b2-1b90-4283-8ee5-1ac95d34ee9b&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/171",
"resource": {
"resourceType": "Immunization",
"id": "171",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/169"
},
"occurrenceDateTime": "1950-04-07T00:11:45-05:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/141",
"resource": {
"resourceType": "Immunization",
"id": "141",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/139"
},
"occurrenceDateTime": "1945-03-09T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/240",
"resource": {
"resourceType": "Immunization",
"id": "240",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/238"
},
"occurrenceDateTime": "1964-02-14T00:11:45-05:00",
"primarySource": true,
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/247",
"resource": {
"resourceType": "Immunization",
"id": "247",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/244"
},
"occurrenceDateTime": "1968-06-07T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/201",
"resource": {
"resourceType": "Immunization",
"id": "201",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/199"
},
"occurrenceDateTime": "1957-05-17T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/189",
"resource": {
"resourceType": "Immunization",
"id": "189",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/187"
},
"occurrenceDateTime": "1954-04-30T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/295",
"resource": {
"resourceType": "Immunization",
"id": "295",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/292"
},
"occurrenceDateTime": "1976-05-07T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/288",
"resource": {
"resourceType": "Immunization",
"id": "288",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/285"
},
"occurrenceDateTime": "1975-05-02T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/271",
"resource": {
"resourceType": "Immunization",
"id": "271",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/268"
},
"occurrenceDateTime": "1974-04-26T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Immunization/226",
"resource": {
"resourceType": "Immunization",
"id": "226",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization"
]
},
"status": "completed",
"vaccineCode": {
"coding": [
{
"system": "http://hl7.org/fhir/sid/cvx",
"code": "140",
"display": "Influenza, seasonal, injectable, preservative free"
}
],
"text": "Influenza, seasonal, injectable, preservative free"
},
"patient": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/223"
},
"occurrenceDateTime": "1962-06-01T01:11:45-04:00",
"primarySource": true,
"location": {
"reference": "Location/86",
"display": "PCP87052"
}
},
"search": {
"mode": "match"
}
}
]
}Implanted Devices
Definition : This resource identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
Retrieving a patient's implantable devices/UDI
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
Device
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Device
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Device/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Device",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "43069338026389",
"carrierHRF": "(01)43069338026389(11)000302(17)250317(10)1134(21)842026117977"
}
],
"status": "active",
"distinctIdentifier": "43069338026389",
"manufactureDate": "2000-03-02T18:33:18-05:00",
"expirationDate": "2025-03-17T19:33:18-04:00",
"lotNumber": "1134",
"serialNumber": "842026117977",
"deviceName": [
{
"name": "Implantable defibrillator, device (physical object)",
"type": "user-friendly-name"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72506001",
"display": "Implantable defibrillator, device (physical object)"
}
],
"text": "Implantable defibrillator, device (physical object)"
},
"patient": {
"reference": "Patient/{{PPG}}"
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Device?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "{{ResourceId}}",
"meta": {
"lastUpdated": "2022-11-04T16:03:45.057+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Device?patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Device/{{ResourceId}}",
"resource": {
"resourceType": "Device",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "43069338026389",
"carrierHRF": "(01)43069338026389(11)000302(17)250317(10)1134(21)842026117977"
}
],
"status": "active",
"distinctIdentifier": "43069338026389",
"manufactureDate": "2000-03-02T18:33:18-05:00",
"expirationDate": "2025-03-17T19:33:18-04:00",
"lotNumber": "1134",
"serialNumber": "842026117977",
"deviceName": [
{
"name": "Implantable defibrillator, device (physical object)",
"type": "user-friendly-name"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72506001",
"display": "Implantable defibrillator, device (physical object)"
}
],
"text": "Implantable defibrillator, device (physical object)"
},
"patient": {
"reference": "Patient/{{PPG}}"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Device/793",
"resource": {
"resourceType": "Device",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"
]
},
"udiCarrier": [
{
"deviceIdentifier": "43069338026389",
"carrierAIDC": "iVBORw0KGgoAAAANSUhEUgAAAioAAAB2CAIAAABpgS9BAAADHUlEQVR42u3aXY+iMBiAUbrZ//+XuxcmpunXvkABNedczahAReWZdkxbIee8bVtK6f3zS3tLaXTv6/b5nttHtuMZHaW8JXJvu8/4GNp72+NGxhN5jvPnHn8tInubn4fIfiKjHZ35+fth1bM49g4/dpaOfWrOnMk7X829449/ciOfzcjrFX/FV73f4sfdexWdv8fOvB9G17T4FW/+WkfOw8ufDQBuJz8AyA8A8gMA8gOA/ACA/AAgPwAgPwDIDwDIDwDyA4D8AID8ACA/ACA/AMgPAMgPAPIDAPIDgPwAID8AID8AyA8AyA8A8gMA8gOA/ACA/AAgPwDIDwDIDwDyAwDyA4D8AID8ACA/ACA/AMgPAPIDAPIDgPwAgPwAID8AID8AyA8AyA8A8gOA/ACA/AAgPwAgPwDIDwDIDwDyAwDyA4D8ACA/ACA/AMgPAMgPAPIDAPIDgPwAgPwAID8AyA8AyA8A8gMA8gOA/ACA/AAgPwAgPwDIDwDyAwDyA4D8AID8ACA/ACA/AMgPAMgPAPIDgPw4BQDIDwDyAwDyA4D8AID8ACA/ACA/AMgPAMgPAPIDgPwAgPwAID8AID8AfJuUc3YWADD7AUB+AOACf50CrpBSqm65dJn3dbgDhyjHeWaEKS1bx141pAefAsgPT7rzWpZzboO3d5yfc/39wCHBchbfYGXDPmdIYPYDW/dv+fev3eWm93pa+bDycjy/4p9cwhoNafRzdZTJM9o1pPYo5eajExI/evdkPrX6h/zAstgEO9FtUtmeqkDdDYP7PJPJ4Bylu/mufXaLMip39Zj40bttO3nqQH54XnvZ6oZk19XtGy+FB8bcVme0k//uPHh0q3zID7/fpPlS1fK518LN29nY1UOqgn1Pm3UI+eEHtbOfdrXnqTnH1dOshV/svrQQVtu4h2++8UB7tqOrPccuu8GtRnOa6l/xB/6TtHxIVzx3MyHMfvid2ET+pp53qNpq/kWv97Jetc/gd+RGaQxuPj/62iHN5y7Bo1cns/yqoZkQd1wivL34xskT8O0svgFg9gOA2Q8AyA8Av+MfJjJq5w+06kcAAAAASUVORK5CYII="
}
],
"status": "active",
"distinctIdentifier": "43069338026389",
"manufactureDate": "2000-03-02T18:33:18-05:00",
"expirationDate": "2025-03-17T19:33:18-04:00",
"lotNumber": "1134",
"serialNumber": "842026117977",
"deviceName": [
{
"name": "Implantable defibrillator, device (physical object)",
"type": "user-friendly-name"
}
],
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "72506001",
"display": "Implantable defibrillator, device (physical object)"
}
],
"text": "Implantable defibrillator, device (physical object)"
},
"patient": {
"reference": "Patient/{{PPG}}"
}
},
"search": {
"mode": "match"
}
}
]
}Laboratory Test Results
Definition : Measurements and simple assertions made about a patient, device or other subject like Laboratory Data
Retrieving a patient's laboratory test results
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/patientid/123/testDetail/456/account/glace?access_token={access_token}
| Name | Type | Default Value | Description |
|---|---|---|---|
| Patient Id * | Integer - URL parameter | - | Account specific ID of the patient, retrieved from Centralized Patient Database |
| Account Id * | String - URL parameter | - | Logical Id of the account where Patient registered, retrieved from Centralized Patient Database |
| Test Detail Id * | Integer - URL parameter | - | Id of the lab test performed on the patient |
| Resource ID* | String - Request parameter | - | Issued by the authorization server to the client to access FHIR APIs. |
Note : * parameters are required.
A DAF Observation is returned.
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
| code | CodeableConcept | 1..1 | A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested. |
| subject | Reference ( Pateint | Group | Location | Device ) | 1..1 | On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
| status | code | 1..1 | The status of the order. |
| note | Annotation | 0..* | Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions. |
For more information on this resource, see http://www.hl7.org/fhir/R4/observation.html
Response JSON Contains following information
Note : All API responses will be in the form on JSONArray or JSONObject. If the Patient exists in more the one account, all the response objects will be bundled into one.
{
"glace": [
{
"date": "2017-10-24T00:00:00+05:30",
"performer": {
"reference": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/practitioner/employee/44/account/glace?access_token={access_token}",
"display": "ipad Test M.D."
},
"route": {
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.3.26.1.1",
"code": "0"
}
]
},
"patient": {
"reference": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/patient/patientid/3524/account/glace?access_token={access_token}",
"display": "TEST ASSOCIATE"
},
"reported": true,
"id": "7733b3ab-8879-4c98-b1fd-d67fc162248c",
"vaccineCode": {
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.6.59",
"code": "19",
"display": "BCG"
}
],
"text": "BCG"
},
"resourceType": "Immunization",
"status": "completed",
"wasNotGiven": false
}
]
}
Medication Order
Definition : An order for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationOrder" rather than "MedicationPrescription" to generalize the use across inpatient and outpatient settings as well as for care plans, etc.
Retrieving a patient's medication orders
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationOrder/patientid/123/account/glace?access_token={access_token}
| Name | Type | Default Value | Description |
|---|---|---|---|
| Patient Id * | Integer - URL parameter | - | Account specific ID of the patient, retrieved from Centralized Patient Database |
| Account Id * | String - URL parameter | - | Logical Id of the account where Patient registered, retrieved from Centralized Patient Database |
| From Date | String - Request parameter (MM-DD-YYYY) |
- | Starting date of the date range period. To search for a specific date only mention the From date and do not mention End date. |
| End Date | String - Request parameter (MM-DD-YYYY) |
- | Ending date of the date range period |
| Resource ID* | String - Request parameter | - | Issued by the authorization server to the client to access FHIR APIs. |
Note : * parameters are required.
A DAF MedicationOrder is returned.
| Name | Type | Cardinality | Description |
|---|---|---|---|
| prescriber | Reference ( Practitioner ) | 0..1 | The healthcare professional responsible for authorizing the prescription. |
| medicationReference | CodeableConcept | Reference ( Medication ) | 1..1 | Identifies the medication being administered. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications. |
| dosageInstruction | 0..* | Indicates how the medication is to be used by the patient. | |
| - dosageInstruction.text | string | 0..1 | Free text dosage instructions can be used for cases where the instructions are too complex to code. The content of this attribute does not include the name or description of the medication. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication. It is expected that the text instructions will always be populated. If the dosage.timing attribute is also populated, then the dosage.text should reflect the same information as the timing. |
| - dosageInstruction.route | CodeableConcept | 0..1 | A code specifying the route or physiological path of administration of a therapeutic agent into or onto a patient's body. |
| - dosageInstruction.method | CodeableConcept | 0..1 | A coded value indicating the method by which the medication is introduced into or onto the body. Most commonly used for injections. For examples, Slow Push; Deep IV. |
| - dosageInstruction.doseQuantity | Range | SimpleQuantity | 0..1 | The amount of therapeutic or other substance given at one administration event. |
| dispenseRequest | 0..1 | Indicates the specific details for the dispense or medication supply part of a medication order (also known as a Medication Prescription). Note that this information is NOT always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department. | |
| - dispenseRequest.quantity | SimpleQuantity | 0..1 | The amount that is to be dispensed for one fill. |
| - dispenseRequest.numberOfRepeatsAllowed | positiveInt | 0..1 | An integer indicating the number of additional times (aka refills or repeats) the patient can receive the prescribed medication. Usage Notes: This integer does NOT include the original order dispense. This means that if an order indicates dispense 30 tablets plus "3 repeats", then the order can be dispensed a total of 4 times and the patient can receive a total of 120 tablets. |
| - dispenseRequest.expectedSupplyDuration | Duration | 0..1 | Identifies the period time over which the supplied product is expected to be used, or the length of time the dispense is expected to last. |
| patient | Reference ( Patient ) | 0..1 | A link to a resource representing the person to whom the medication will be given. |
| dateWritten | dateTime | 0..1 | The date (and perhaps time) when the prescription was written. |
| status | code | 0..1 | A code specifying the state of the order. Generally this will be active or completed state. |
For more information on this resource, see http://www.hl7.org/fhir/R4/medicationorder.html
Response JSON Contains following information
Note : All API responses will be in the form on JSONArray or JSONObject. If the Patient exists in more the one account, all the response objects will be bundled into one.
{
"glace": [
{
"prescriber": {
"reference": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/practitioner/employee/216/account/glace?access_token={access_token}",
"display": "Ivy Stuart "
},
"medicationReference": {
"reference": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/medication/rxnorm/f/rxname/crestor/account/glace?access_token={access_token}",
"display": "Crestor 5 mg tablet"
},
"dosageInstruction": [
{
"route": {
"text": "oral"
},
"method": {
"text": "Take"
},
"doseQuantity": {
"unit": "Tablet",
"value": 10
},
"text": "1"
}
],
"dispenseRequest": {
"quantity": {
"unit": "Tablet",
"value": 10
},
"numberOfRepeatsAllowed": 1,
"expectedSupplyDuration": {
"unit": "days",
"system": "urn:oid:urn:oid:2.16.840.1.113883.6.8",
"code": "d",
"value": 1
}
},
"patient": {
"reference": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/patient/patientid/3524/account/glace?access_token={access_token}",
"display": "TEST ASSOCIATE"
},
"id": "72bd205d-1265-4ac6-8037-c461f438453d",
"dateWritten": "2018-04-25T00:00:00+05:30",
"resourceType": "MedicationOrder",
"status": "active"
}
]
}
Patient
Definition : Demographics and other administrative information about an individual or animal receiving care or other health-related services.
Retrieving a patient's information
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
Patient
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | an identifier for this patient |
| identifier.system | uri | 1..1 | the namespace for the identifier value |
| identifier.value | string | 1..1 | the value that is unique within the system. |
| active | boolean | 0..1 | whether this patient's record is in active use |
| name | HumanName | 1..* | a name associated with the patient |
| name.use | code | 0..1 | usual |
| name.family | string | 0..1 | family name (often called 'Surname') |
| name.given | string | 0..* | given names (not always 'first'). Includes middle names |
| name.prefix | string | 0..* | parts that come before the name |
| name.suffix | string | 0..* | parts that come after the name |
| name.period | Period | 0..* | time period when name was/is in use |
| telecom | ContactPoint | 0..* | a contact detail for the individual |
| telecom.system | code | 1..1 | phone |
| telecom.value | string | 1..1 | the actual contact point details |
| telecom.use | code | 0..1 | home |
| gender | code | 1..1 | male |
| birthDate | date | 0..1 | the date of birth for the individual |
| deceasedBoolean | boolean | 0..1 | indicates if the individual is deceased or not |
| deceasedDateTime | dateTime | 0..1 | indicates if the individual is deceased or not |
| address | Address | 0..* | addresses for the individual |
| address.line | string | 0..* | street name, number, direction & P.O. Box etc. |
| address.city | string | 0..1 | name of city, town etc. |
| address.state | string | 0..1 | sub-unit of country (abbreviations ok) - Binding |
| address.postalCode | string | 0..1 | |
| address.country | string | 0..1 | country (e.g. can be ISO 3166 2 or 3 letter code) |
| address.period | Period | 0..1 | time period when address was/is in use |
| maritalStatus | CodeableConcept | 0..1 | marital (civil) status of a patient |
| multipleBirthBoolean | boolean | 0..1 | whether patient is part of a multiple birth |
| multipleBirthInteger | integer | 0..1 | whether patient is part of a multiple birth |
| photo | Attachment | 0..* | image of the patient |
| contact | BackboneElement | 0..* | a contact party (e.g. guardian, partner, friend) for the patient |
| communication | BackboneElement | 0..* | a list of languages which may be used to communicate with the patient about his or her health |
| communication.language | CodeableConcept | 1..1 | the language which can be used to communicate with the patient about his or her health - Binding |
| generalPractitioner | Reference | 0..* | patient's nominated primary care provider |
| managingOrganization | Reference | 0..1 | organization that is the custodian of the patient record |
| link | BackboneElement | 0..* | link to another patient resource that concerns the same actual person |
Search Parameters
| Name | Type | Description |
|---|---|---|
| _id | reference | patient id |
| active | token | whether the patient record is active |
| address | string | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| birthdate | date | the patient's date of birth |
| death-date | date | the date of death has been provided and satisfies this search value |
| deceased | token | this patient has been marked as deceased, or as a death date entered |
| family | string | a portion of the family name of the patient |
| gender | token | gender of the patient |
| given | string | a portion of the given name of the patient |
| identifier | token | a patient identifier |
| language | token | language code (irrespective of use value) |
| link | reference | all patients linked to the given patient |
| name | string | a server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| telecom | token | the value in any kind of telecom details of the patient |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Patient
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Patient
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Patient/{{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Patient",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Generated by <a href=\"https://github.com/synthetichealth/synthea\">Synthea</a>.Version identifier: v2.6.1-3-g50f4f58f\n . Person seed: -7901283747506674198 Population seed: 3</div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Non Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName",
"valueString": "Arnetta705 Walker122"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
"valueAddress": {
"city": "Brookline",
"state": "Massachusetts",
"country": "US"
}
}
],
"identifier": [
{
"system": "https://github.com/synthetichealth/synthea",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
],
"text": "Medical Record Number"
},
"system": "http://hospital.smarthealthit.org",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS",
"display": "Social Security Number"
}
],
"text": "Social Security Number"
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "999-47-5768"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "DL",
"display": "Driver's License"
}
],
"text": "Driver's License"
},
"system": "urn:oid:2.16.840.1.113883.4.3.25",
"value": "S99921496"
}
],
"name": [
{
"use": "official",
"family": "Bosco882",
"given": [
"Lucien408"
],
"prefix": [
"Mr."
]
}
],
"telecom": [
{
"system": "phone",
"value": "555-510-6254",
"use": "home"
}
],
"gender": "male",
"birthDate": "1940-03-29",
"deceasedDateTime": "1977-07-14T04:17:45-04:00",
"address": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/geolocation",
"extension": [
{
"url": "latitude",
"valueDecimal": 42.674176102041564
},
{
"url": "longitude",
"valueDecimal": -71.31980043648745
}
]
}
],
"line": [
"934 Olson Highlands"
],
"city": "Lowell",
"state": "MA",
"postalCode": "01854",
"country": "US",
"period": {
"start": "1940-03-29"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "M"
}
],
"text": "M"
},
"multipleBirthBoolean": false,
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US",
"display": "English"
}
],
"text": "English"
}
}
]
}Using patient name
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Patient?name=Bosco882
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "9d5b7bcb-c183-4b92-bcd8-b96b59a121e2",
"meta": {
"lastUpdated": "2022-11-04T16:03:14.259+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": " https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Patient?name=Bosco882"
}
],
"entry": [
{
"fullUrl": " https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Patient/{{PPG}}",
"resource": {
"resourceType": "Patient",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Generated by <a href=\"https://github.com/synthetichealth/synthea\">Synthea</a>.Version identifier: v2.6.1-3-g50f4f58f\n . Person seed: -7901283747506674198 Population seed: 3</div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2106-3",
"display": "White"
}
},
{
"url": "text",
"valueString": "White"
}
]
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity",
"extension": [
{
"url": "ombCategory",
"valueCoding": {
"system": "urn:oid:2.16.840.1.113883.6.238",
"code": "2186-5",
"display": "Non Hispanic or Latino"
}
},
{
"url": "text",
"valueString": "Non Hispanic or Latino"
}
]
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName",
"valueString": "Arnetta705 Walker122"
},
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex",
"valueCode": "M"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/patient-birthPlace",
"valueAddress": {
"city": "Brookline",
"state": "Massachusetts",
"country": "US"
}
}
],
"identifier": [
{
"system": "https://github.com/synthetichealth/synthea",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MR",
"display": "Medical Record Number"
}
],
"text": "Medical Record Number"
},
"system": "http://hospital.smarthealthit.org",
"value": "d831ec91-c7a3-4a61-9312-7ff0c4a32134"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "SS",
"display": "Social Security Number"
}
],
"text": "Social Security Number"
},
"system": "http://hl7.org/fhir/sid/us-ssn",
"value": "999-47-5768"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "DL",
"display": "Driver's License"
}
],
"text": "Driver's License"
},
"system": "urn:oid:2.16.840.1.113883.4.3.25",
"value": "S99921496"
}
],
"name": [
{
"use": "official",
"family": "Bosco882",
"given": [
"Lucien408"
],
"prefix": [
"Mr."
]
}
],
"telecom": [
{
"system": "phone",
"value": "555-510-6254",
"use": "home"
}
],
"gender": "male",
"birthDate": "1940-03-29",
"deceasedDateTime": "1977-07-14T04:17:45-04:00",
"address": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/geolocation",
"extension": [
{
"url": "latitude",
"valueDecimal": 42.674176102041564
},
{
"url": "longitude",
"valueDecimal": -71.31980043648745
}
]
}
],
"line": [
"934 Olson Highlands"
],
"city": "Lowell",
"state": "MA",
"postalCode": "01854",
"country": "US",
"period": {
"start": "1940-03-29"
}
}
],
"maritalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
"code": "M",
"display": "M"
}
],
"text": "M"
},
"multipleBirthBoolean": false,
"communication": [
{
"language": {
"coding": [
{
"system": "urn:ietf:bcp:47",
"code": "en-US",
"display": "English"
}
],
"text": "English"
}
}
]
},
"search": {
"mode": "match"
}
}
]
}Location
Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained, or accommodated.
Overview
A Location includes both incidental locations (a place which is used for healthcare without prior designation or authorization) and dedicated, formally appointed locations. Locations may be private, public, mobile or fixed and scale from small freezers to full hospital buildings or parking garages. This profile is used to define the content that will be returned by the API Server in response to requests to access Location resources. All elements described in the Definition and Detailed Definitions below are supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Location
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | identifies this organization across multiple systems (see Profiles for details) |
| active | boolean | 1..1 | whether the organization's record is still in active use |
| type | CodeableConcept | 0..* | kind of organization |
| name | string | 1..1 | name used for the organization |
| alias | string | 0..* | a list of alternate names that the organization is known as, or was known as in the past |
| telecom | ContactPoint | 0..* | a contact detail for the organization |
| address | Address | 0..* | an address for the organization |
| address.line | string | 0..* | street name, number, direction & P.O. Box etc. |
| address.city | string | 0..1 | name of city, town etc. |
| address.state | string | 0..1 | sub-unit of country (abbreviations ok) - Binding |
| address.postalCode | string | 0..1 | |
| address.country | string | 0..1 | country (e.g. can be ISO 3166 2 or 3 letter code) |
| partOf | Reference | 0..1 | the organization of which this organization forms a part |
| contact | BackboneElement | 0..* | contact for the organization for a certain purpose |
| endpoint | Reference | 0..* | technical endpoints providing access to services operated for the organization |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | any identifier for the organization (not the accreditation issuer's identifier) |
| partof | reference | an organization of which this organization forms a part |
| address | string | a (part of the) address of the organization |
| address-state | string | a state specified in an address |
| active | token | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| type | token | a code for the type of organization |
| address-postalcode | string | a postal code specified in an address |
| name | string | a portion of the organization's name or alias |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Location
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Location
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Location/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Location",
"id": "12",
"meta": {
"versionId": "1",
"lastUpdated": "2022-12-13T10:59:50.346-05:00",
"source": "#fwmnGhVzEmjWsJXO",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-location"
]
},
"identifier": [
{
"use": "usual",
"system": "urn:oid:2.16.840.1.113883.3.225",
"value": "14"
}
],
"status": "active",
"name": "TEST LOCATION",
"description": "TEST",
"telecom": [
{
"system": "phone"
}
],
"address": {
"line": [
"65 JAMES STREET"
],
"city": "EDISON",
"state": "NJ",
"postalCode": "08820-3947",
"country": "USA"
},
"managingOrganization": {
"reference": "Organization/1"
}
}
Observation (Vitals)
Definition : Measurements and simple assertions made about a patient, device or other subject like temperature, blood pressure, respiration rate
Retrieving a patient's vitals
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Observation (Vitals)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | business Identifier for observation |
| basedOn | Reference | 0..* | fulfills plan, proposal or order |
| partOf | Reference | 0..* | part of referenced event |
| status | code | 1..1 | registered |
| category | CodeableConcept | 1..* | classification of type of observation |
| code | CodeableConcept | 1..1 | type of observation (code / type) |
| subject | Reference | 1..1 | who and/or what this is about |
| focus | Reference | 0..* | what request fulfills |
| encounter | Reference | 0..1 | healthcare event during which this observation is made |
| effectiveDateTime | dateTime | 0..1 | clinically relevant time/time-period for observation |
| effectivePeriod | Period | 0..1 | clinically relevant time/time-period for observation |
| effectiveTiming | Timing | 0..1 | clinically relevant time/time-period for observation |
| effectiveInstant | instant | 0..1 | clinically relevant time/time-period for observation |
| issued | instant | 0..1 | date/time this was made available |
| performer | Reference | 0..* | who is responsible for the observation |
| valueQuantity | Quantity | 0..1 | actual result |
| valueCodeableConcept | CodeableConcept | 0..1 | actual result |
| valueString | string | 0..1 | actual result |
| valueBoolean | boolean | 0..1 | actual result |
| valueInteger | integer | 0..1 | actual result |
| valueRange | Range | 0..1 | actual result |
| valueRatio | Ratio | 0..1 | actual result |
| valueSampledData | SampledData | 0..1 | actual result |
| valueTime | time | 0..1 | actual result |
| valueDateTime | dateTime | 0..1 | actual result |
| valuePeriod | Period | 0..1 | actual result |
| dataAbsentReason | CodeableConcept | 0..1 | why the result is missing |
| interpretation | CodeableConcept | 0..* | high, low, normal, etc. |
| note | string | 0..1 | comments about the observation |
| bodySite | CodeableConcept | 0..1 | observed body part |
| method | CodeableConcept | 0..1 | how it was done |
| specimen | Reference | 0..1 | specimen used for this observation |
| device | Reference | 0..1 | (Measurement) Device |
| referenceRange | BackboneElement | 0..* | provides guide for interpretation |
| hasMember | Reference | 0..* | who is responsible for the observation |
| component | BackboneElement | 0..* | component results |
| dataAbsentReason | CodeableConcept | 0..1 |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | obtained date/time. If the obtained element is a period, a date that falls in the period |
| code | token | the code of the observation type |
| subject | reference | the subject that the observation is about |
| value-concept | token | the value of the observation, if the value is a CodeableConcept |
| value-date | date | the value of the observation, if the value is a date or period of time |
| patient | reference | the subject that the observation is about (if patient) |
| specimen | reference | specimen used for this observation |
| value-string | string | the value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| performer | reference | who performed the observation |
| value-quantity | quantity | the value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| encounter | reference | encounter related to the observation |
| related-type | token | has-membertarge |
| related-target | reference | resource that is related to this one |
| category | token | the classification of the type of observation |
| status | token | the status of the observation |
| _include | Observation:subject | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles: -
- US Core Laboratory Result Observation Profile
- US Core Pediatric BMI for Age Observation Profile
- US Core Pediatric Head Occipital-frontal Circumference Percentile Profile
- US Core Pediatric Weight for Height Observation Profile
- US Core Pulse Oximetry Profile
- US Core Smoking Status Observation Profile
- Vital Signs Profile
- Supported Profiles: -
| Profile Name | Code | LOINC Name and Comments |
|---|---|---|
| Vital Signs Panel | 85353-1 | Vital signs, weight, height, head circumference, oxygen saturation and BMI panel |
| Respiratory Rate | 9279-1 | Respiratory Rate |
| Heart rate | 8867-4 | Heart rate |
| Oxygen saturation | 2708-6 | Oxygen saturation in Arterial blood |
| Body temperature | 8310-5 | Body temperature |
| Body height | 8302-2 | Body height |
| Head circumference | 9843-4 | Head Occipital-frontal circumference |
| Body weight | 29463-7 | Body weight |
| Body mass index | 39156-5 | Body mass index (BMI) |
| Blood pressure systolic and diastolic | 85354-9 | Blood pressure panel with all children optional |
| Systolic blood pressure | 8480-6 | Systolic blood pressure component |
| Diastolic blood pressure | 8462-4 | Diastolic blood pressure component |
Observation
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/90"
},
"effectiveDateTime": "1940-03-29T00:11:45-05:00",
"issued": "1940-03-29T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?code=72166&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "d1b8f87f-bbfc-49ad-ace3-621cb6ae947e",
"meta": {
"lastUpdated": "2022-11-04T16:03:24.705+00:00"
},
"type": "searchset",
"total": 38,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?code=72166-2&patient={{PPG}}"
},
{
"relation": "next",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}?_getpages=d1b8f87f-bbfc-49ad-ace3-621cb6ae947e&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/90"
},
"effectiveDateTime": "1940-03-29T00:11:45-05:00",
"issued": "1940-03-29T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/187"
},
"effectiveDateTime": "1954-04-30T01:11:45-04:00",
"issued": "1954-04-30T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/117",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/116"
},
"effectiveDateTime": "1941-06-06T01:11:45-04:00",
"issued": "1941-06-06T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/166",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/165"
},
"effectiveDateTime": "1949-04-01T00:11:45-05:00",
"issued": "1949-04-01T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/200",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/199"
},
"effectiveDateTime": "1957-05-17T01:11:45-04:00",
"issued": "1957-05-17T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/138",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/137"
},
"effectiveDateTime": "1944-03-03T01:11:45-04:00",
"issued": "1944-03-03T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/177",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/175"
},
"effectiveDateTime": "1951-09-07T01:11:45-04:00",
"issued": "1951-09-07T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/97",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/96"
},
"effectiveDateTime": "1940-09-06T01:11:45-04:00",
"issued": "1940-09-06T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/196",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/195"
},
"effectiveDateTime": "1956-05-11T01:11:45-04:00",
"issued": "1956-05-11T01:11:45.131-04:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/113",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/112"
},
"effectiveDateTime": "1941-03-07T00:11:45-05:00",
"issued": "1941-03-07T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
},
"search": {
"mode": "match"
}
}
]
}Using category=vital-signs
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?category=vital-signs&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "2ce9d607-692c-4308-a464-1c277b3d8175",
"meta": {
"lastUpdated": "2022-11-04T16:04:02.429+00:00"
},
"type": "searchset",
"total": 26,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?category=vital-signs&patient={{PPG}}"
},
{
"relation": "next",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}?_getpages=2ce9d607-692c-4308-a464-1c277b3d8175&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/455",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodyheight",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8302-2",
"display": "Body Height"
}
],
"text": "Body Height"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/454"
},
"effectiveDateTime": "1952-09-25T19:33:18-04:00",
"issued": "1952-09-25T19:33:18.715-04:00",
"valueQuantity": {
"value": 160,
"unit": "cm",
"system": "http://unitsofmeasure.org",
"code": "cm"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/808",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "85354-9",
"display": "Blood Pressure"
}
],
"text": "Blood Pressure"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/619"
},
"effectivePeriod": {
"start": "1994-05-19T19:33:18-04:00",
"end": "1994-05-19T20:33:18-04:00"
},
"issued": "1994-05-19T19:33:18.715-04:00",
"component": [
{
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8462-4",
"display": "Diastolic Blood Pressure"
}
],
"text": "Diastolic Blood Pressure"
},
"valueQuantity": {
"value": 85,
"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": 129,
"unit": "mm[Hg]",
"system": "http://unitsofmeasure.org",
"code": "mm[Hg]"
}
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/798",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/vitalsigns",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8289-1",
"display": "Head Occipital-frontal circumference Percentile"
}
]
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"effectiveDateTime": "1940-10-05T00:00:00+00:00",
"dataAbsentReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/803",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodyweight",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "29463-7",
"display": "Body Weight"
}
],
"text": "Body Weight"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/583"
},
"effectiveDateTime": "1983-03-17T18:33:18-05:00",
"issued": "1983-03-17T18:33:18.715-05:00",
"dataAbsentReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/813",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
},
{
"system": "http://loinc.org",
"code": "8331-1",
"display": "Oral temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/707"
},
"effectivePeriod": {
"start": "2009-08-19T19:33:18-04:00",
"end": "2009-08-19T20:33:18-04:00"
},
"issued": "2009-08-19T19:33:18.715-04:00",
"valueQuantity": {
"value": 37.799,
"unit": "Cel",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/708",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
},
{
"system": "http://loinc.org",
"code": "8331-1",
"display": "Oral temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/707"
},
"effectiveDateTime": "2009-08-19T19:33:18-04:00",
"issued": "2009-08-19T19:33:18.715-04:00",
"valueQuantity": {
"value": 37.799,
"unit": "Cel",
"system": "http://unitsofmeasure.org",
"code": "Cel"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/801",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/bodytemp",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8310-5",
"display": "Body temperature"
},
{
"system": "http://loinc.org",
"code": "8331-1",
"display": "Oral temperature"
}
],
"text": "Body temperature"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/707"
},
"effectiveDateTime": "2009-08-19T19:33:18-04:00",
"issued": "2009-08-19T19:33:18.715-04:00",
"dataAbsentReason": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "Unknown"
}
],
"text": "Unknown"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/420",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/pediatric-bmi-for-age"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "59576-9",
"display": "Body mass index (BMI) [Percentile] Per age and gender"
}
],
"text": "Body mass index (BMI) [Percentile] Per age and gender"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/419"
},
"effectiveDateTime": "1944-02-10T19:33:18-04:00",
"issued": "1944-02-10T19:33:18.715-04:00",
"valueQuantity": {
"value": 34.705,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/811",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/vitalsigns",
"http://hl7.org/fhir/us/core/StructureDefinition/head-occipital-frontal-circumference-percentile"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "Vital Signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8289-1",
"display": "Head Occipital-frontal circumference Percentile"
}
]
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"effectivePeriod": {
"start": "1940-10-05T00:00:00+00:00",
"end": "1940-10-05T01:00:00+00:00"
},
"valueQuantity": {
"value": 23,
"unit": "%",
"system": "http://unitsofmeasure.org",
"code": "%"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/806",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/StructureDefinition/heartrate",
"http://hl7.org/fhir/StructureDefinition/vitalsigns"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "vital-signs",
"display": "vital-signs"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "8867-4",
"display": "Heart rate"
}
],
"text": "Heart rate"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/665"
},
"effectivePeriod": {
"start": "2003-07-10T19:33:18-04:00",
"end": "2003-07-10T20:33:18-04:00"
},
"issued": "2003-07-10T19:33:18.715-04:00",
"valueQuantity": {
"value": 65,
"unit": "/min",
"system": "http://unitsofmeasure.org",
"code": "/min"
}
},
"search": {
"mode": "match"
}
}
]
}Conditions (Problems)
Definition : The Condition resource is used to fetch the list of problem lists associated with a patient. The resource shall conform to the US Core Condition Profile (v3.1.1: STU3).
Retrieving a patient's health concerns Problems
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Conditions (Problems)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Condition resource entry id. |
| meta | Meta | 0..1 | Metadata (profile and last updated date/time) about the resource |
| clinicalStatus | CodeableConcept | 0..1 | Current clinical status of the condition |
| verificationStatus | CodeableConcept | 0..1 | Current verification status of the condition |
| category | CodeableConcept | 1..* | Code that identifies the type of condition |
| severity | CodeableConcept | 0..1 | Severity of condition |
| code | CodeableConcept | 1..1 | Code that identifies the condition |
| subject | Reference(US Core Patient Profile) | 1..1 | Patient who has the condition |
| onset[x]:onsetDateTime | dateTime | 0..1 | Estimated time the condition began |
| abatement[x]:abatementDateTime | dateTime | 0..1 | The time when condition resolved |
| recordedDate | dateTime | 0..1 | Date this condition was recorded |
| recorder | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson) | 0..1 | Practitioner reference who recorded the condition |
| note | Annotation | 0..* | Additional information about the Condition |
| encounter | Reference(Encounter) | 0..1 | Encounter reference this condition created as part of |
Search Parameters
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Condition
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/259"
},
"onsetDateTime": "1974-03-29T01:11:45-04:00",
"recordedDate": "1974-03-29T01:11:45-04:00"
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2024-10-10T17:07:28.815-04:00",
"source": "#F0DDcbLavfEzdZM1",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-problems-health-concerns"
]
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/condition-assertedDate",
"valueDateTime": "2016-08-10"
}
],
"identifier": [
{
"system": "https://github.com/inferno-framework/us-core-test-kit",
"value": "b9fbaa22-6097-11ed-9b6a-0242ac120002"
}
],
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "resolved",
"display": "Resolved"
}
],
"text": "Resolved"
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed",
"display": "Confirmed"
}
],
"text": "Confirmed"
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "problem-list-item",
"display": "Problem List Item"
}
],
"text": "Problem List Item"
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "432119003",
"display": "Influenza (disorder)"
}
],
"text": "Influenza (disorder)"
}
},
{
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "445281000124101",
"display": "Nutrition impaired due to limited access to healthful foods (finding)"
}
],
"text": "Nutrition impaired due to limited access to healthful foods (finding)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"abatementDateTime": "2016-08-10T07:15:07-08:00",
"recordedDate": "2016-08-10T07:15:07-08:00"
}
Condition (Encounter Diagnostics)
Definition : The Condition resource is used to fetch the list of assessment (encounter diagnosis) associated with a patient. The resource shall conform to the US Core Condition Profile (v3.1.1: STU3)
Retrieving a patient's health concerns
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Condition (Encounter Diagnostics)
Resource Content
| Element Name | Data Type | Card. | Description & Constraints |
|---|---|---|---|
| id | string | 0..1 | Condition resource entry id. |
| meta | Meta | 0..1 | Metadata (profile and last updated date/time) about the resource. |
| clinicalStatus | CodeableConcept | 0..1 | Current clinical status of the condition. |
| verificationStatus | CodeableConcept | 0..1 | Current verification status of the condition. |
| category | CodeableConcept | 1..* | Code that identifies the type of condition. |
| severity | CodeableConcept | 0..1 | Severity of condition. |
| code | CodeableConcept | 1..1 | Code that identifies the condition. |
| subject | Reference (US Core Patient Profile) | 1..1 | Patient who has the condition. |
| onset[x]:onsetDateTime | dateTime | 0..1 | Estimated time the condition began. |
| abatement[x]:abatementDateTime | dateTime | 0..1 | The time when the condition resolved. |
| recordedDate | dateTime | 0..1 | Date this condition was recorded. |
| recorder | Reference (Practitioner | PractitionerRole | Patient | RelatedPerson) | 0..1 | Practitioner reference who recorded the condition. |
| note | Annotation | 0..* | Additional information about the Condition. |
| encounter | Reference (Encounter) | 0..1 | Encounter reference this condition created as part of. |
Search Parameters
| Name | Type | Description |
|---|---|---|
| severity | token | the severity of the condition |
| code | token | code for the condition |
| evidence | token | manifestation/symptom |
| subject | reference | who has the condition |
| clinical-status | token | the clinical status of the condition |
| encounter | reference | encounter when condition first asserted |
| abatement-boolean | token | abatement boolean (boolean is true or non-boolean values are present) |
| onset-date | date | date related onsets (dateTime and Period) |
| abatement-date | date | date-related abatements (dateTime and period) |
| asserter | reference | person who asserts this condition |
| stage | token | simple summary (disease specific) |
| patient | reference | who has the condition |
| context | reference | encounter or episode when condition first asserted |
| recorded-date | date | date record was believed accurate |
| category | token | the category of the condition |
| _include | undefined | condition:subject |
| _revinclude | provenance:target |
Search Parameters
Error Codes
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Condition
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition"
]
},
"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "active"
}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"
}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "encounter-diagnosis",
"display": "Encounter Diagnosis"
}
]
}
],
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "88805009",
"display": "Chronic congestive heart failure (disorder)"
}
],
"text": "Chronic congestive heart failure (disorder)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/259"
},
"onsetDateTime": "1974-03-29T01:11:45-04:00",
"recordedDate": "1974-03-29T01:11:45-04:00"
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Condition?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Condition",
"id": "{{ResourceId}}",
"meta": {
"versionId": "2",
"lastUpdated": "2024-10-10T16:02:11.937-04:00",
"source": "#sqze4h2j5R4ue87I",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition-encounter-diagnosis"
]
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"}
]
,"system": "http://terminology.hl7.org/CodeSystem/data-absent-reason",
"code": "unknown",
"display": "unknown"}
]
,"system": "urn:oid:2.16.840.1.113883.3.225",
"value": "1177"}
]
,"clinicalStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
"code": "inactive"}
]
},
"verificationStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-ver-status",
"code": "confirmed"}
]
},
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/condition-category",
"code": "problem-list-item"}
]
}
],
"code": {
"coding": [
{
"code": "R05.3",
"display": "Chronic cough"
}
]
},
"subject": {
"reference": "Patient/{{PPG}}",
},
"encounter": {
"reference": "Encounter/86653"
},
"onsetDateTime": "2024-10-07T15:34:31-04:00",
"abatementDateTime": "2024-10-07T15:34:31-04:00"
}
Observation (Labs)
Definition : The Laboratory Results resource is used to fetch the lab results associated with a patient. The resource shall conform to the US Core Laboratory Results Profile (v3.1.1: STU3)
Retrieving a patient's immunizations
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Laboratory Results resource entry id. |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource. |
| status | code | 1..1 | Current status of the laboratory result. |
| category | CodeableConcept | 1..* | Identifies the type of Observation results. |
| code | CodeableConcept | 1..1 | Code that identifies laboratory test name. |
| subject | Reference(US Core Patient Profile) | 1..1 | Patient the observation is about. |
| encounter | Reference(Encounter) | 0..1 | Encounter reference during which this observation is made. |
| effective[x]:effectiveDateTime | dateTime | 0..1 | Clinically relevant time/time-period for observation. |
| issued | instant | 0..1 | Date/Time this version was made available. |
| performer | Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | RelatedPerson) | 0..* | Practitioner reference who is responsible for the observation. |
| value[x]:valueQuantity | Quantity | 0..1 | Result Value. |
| referenceRange | BackboneElement | 0..* | Provides guide for interpretation. |
| interpretation | CodeableConcept | 0..* | Helps in interpretation of observation. |
| note | Annotation | 0..* | Comments about the observation. |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | obtained date/time. If the obtained element is a period, a date that falls in the period |
| code | token | the code of the observation type |
| subject | reference | the subject that the observation is about |
| value-concept | token | the value of the observation, if the value is a CodeableConcept |
| value-date | date | the value of the observation, if the value is a date or period of time |
| patient | reference | the subject that the observation is about (if patient) |
| specimen | reference | specimen used for this observation |
| value-string | string | the value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| performer | reference | who performed the observation |
| value-quantity | quantity | the value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| encounter | reference | encounter related to the observation |
| related-type | token | has-membertarge |
| related-target | reference | resource that is related to this one |
| category | token | the classification of the type of observation |
| status | token | the status of the observation |
| _include | Observation:subject | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Observation
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/90"
},
"effectiveDateTime": "1940-03-29T00:11:45-05:00",
"issued": "1940-03-29T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?code=72166&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "a6d022ba-3126-497c-8525-f6874b578972",
"meta": {
"lastUpdated": "2022-08-22T10:50:54.024-05:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?code=72166-2&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"lastUpdated": "2022-08-16T02:27:08.000-04:00",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"1\" class=\"hapiTableOfValues\"><tbody><tr><td>Status</td><td><span>FINAL</span></td></tr><tr><td>Observation code</td><td><span>25318-7</span></td></tr><tr><td>Observation name</td><td><span>1-Methyl-histidine,Qn,24hr,Ur</span></td></tr><tr><td>Observation Date</td><td><span>15 August 2022</span></td></tr></tbody></table></div>"
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "laboratory",
"display": "Laboratory"
}
],
"text": "Laboratory"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "25318-7",
"display": "1-Methyl-histidine,Qn,24hr,Ur"
}
],
"text": "1-Methyl-histidine,Qn,24hr,Ur"
},
"effectiveDateTime": "2022-08-16T00:00:00-04:00",
"issued": "2022-08-16T00:00:00.000-04:00",
"performer": [
{
"reference": "Organization/12",
"type": "Organization"
}
],
"valueString": "123",
"subject": {
"reference": "Patient/66"}
}
}
],
"search": {
"mode": "match"
}
}
]
}
Observation (Social History)
Definition : The Smoking Status resource is used to fetch smoking status associated with a patient. The resource shall conform to the US Core Smoking Status Profile (v3.1.1: STU3)
Retrieving a patient's Smoking Status
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Observation (Social History)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Smoking Status resource entry id |
| meta | Meta | 0..1 | Metadata (profile and last updated date/time) about the resource |
| status | code | 1..1 | The current smoking status |
| category | CodeableConcept | 0..* | Classification of type of observation |
| code | CodeableConcept | 1..1 | Code that identifies the type of Smoking Status |
| subject | Reference(US Core Patient Profile) | 1..1 | The person this observation is about |
| encounter | Reference(Encounter) | 0..1 | Encounter reference when this observation was made |
| effective[x]:effectivePeriod | Period | 0..1 | Date and time period when the observation was effective |
| issued | instant | 1..1 | Date/Time this observation was made available |
| performer | Reference(Practitioner | Practitioner Role | Organization | CareTeam | Patient | RelatedPerson) | 0..* | Practitioner reference who is responsible for the observation |
| value[x]:valueCodeableConcept | CodeableConcept | 1..1 | Code that identifies the type of observation relevant to the patient |
| note | Annotation | 0..* | Comments about the observation |
| component | BackboneElement | 0..* | Component that defines the type of smoker the patient is |
| component | BackboneElement | 0..* | Component that defines the past smoking status of a non-smoker patient |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | obtained date/time. If the obtained element is a period, a date that falls in the period |
| code | token | the code of the observation type |
| subject | reference | the subject that the observation is about |
| value-concept | token | the value of the observation, if the value is a CodeableConcept |
| value-date | date | the value of the observation, if the value is a date or period of time |
| patient | reference | the subject that the observation is about (if patient) |
| specimen | reference | specimen used for this observation |
| value-string | string | the value of the observation, if the value is a string, and also searches in CodeableConcept.text |
| performer | reference | who performed the observation |
| value-quantity | quantity | the value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
| encounter | reference | encounter related to the observation |
| related-type | token | has-membertarge |
| related-target | reference | resource that is related to this one |
| category | token | the classification of the type of observation |
| status | token | the status of the observation |
| _include | Observation:subject | |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Observation
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "survey",
"display": "survey"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status NHIS"
}
],
"text": "Tobacco smoking status NHIS"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/90"
},
"effectiveDateTime": "1940-03-29T00:11:45-05:00",
"issued": "1940-03-29T00:11:45.131-05:00",
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "266919005",
"display": "Never smoker"
}
],
"text": "Never smoker"
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?code=72166&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "ebd945a7-cbe9-4d0f-a88d-fde42c4cd006",
"meta": {
"lastUpdated": "2022-08-22T10:49:27.969-05:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation?code=72166-2&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Observation/{{ResourceId}}",
"resource": {
"resourceType": "Observation",
"id": "{{ResourceId}}",
"meta": {
"lastUpdated": "2022-08-16T09:13:48.560-04:00",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-smokingstatus"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"1\" class=\"hapiTableOfValues\"><tbody><tr><td>Status</td><td><span>FINAL</span></td></tr><tr><td>Observation code</td><td><span>72166-2</span></td><span><tr><td>Observation name</td><td><span>Tobacco smoking status</span></td></tr></span><tr><td>Observation Date</td><td><span>07 January 2022</span></td></tr></tbody></table></div>"
},
{
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/observation-category",
"code": "social-history",
"display": "Social History"
}
],
"text": "Social History"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "72166-2",
"display": "Tobacco smoking status"
}
]
},
"subject": {
"reference": "Patient/{{PPG}}",
"type": "Patient"
},
"encounter": {
"reference": "Encounter/90",
"type": "Encounter"
},
"effectivePeriod": {
"start": "2022-01-08T00:00:00-05:00"
},
"issued": "2022-08-04T12:28:32.380-04:00",
"performer": [
{
"reference": "Practitioner/105",
"type": "Practitioner"
}
],
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "77176002",
"display": "Smoker"
}
],
"text": "current smoker"
},
"note": [
{
"text": "When did you start smoking? : 2022-08-01"
},
{
"text": "How often do you smoke cigarettes? : every day"
},
{
"text": "How many cigarettes a day do you smoke? : 6-10"
},
{
"text": "How soon after you wake up do you smoke your first cigarette? : 31-60 minutes"
},
{
"text": "Are you interested in quitting? : Thinking about quitting"
}
],
"component": [
{
"code": {
"text": "Additional Findings: Tobacco User"
},
"valueCodeableConcept": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "160603005",
"display": "Light cigarette smoker (1-9 cigs/day)"
}
],
"text": "Light cigarette smoker ((1-9 cigs/day)"
}
}
],
"search": {
"mode": "match"
}
}
]
}
DiagnosticReport (Laboratory Results Reporting)
Definition : The Diagnostic Report for Lab Results resource is used to fetch the manual and electronic lab results associated with a patient. The resource shall conform to the US Core Diagnostic Report Laboratory Results Profile (v3.1.1: STU3)
Retrieving a patient's laboratory result diagnostic reports
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
DiagnosticReport
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Diagnostic Report for Lab resource entry id. |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource |
| status | code | 1..1 | Current status of the Diagnostic Report for Lab |
| category:LaboratotySlice | CodeableConcept | 1..* | Category the Diagnostic Report belongs to |
| code | CodeableConcept | 1..1 | Code that identifies the lab order |
| subject | Reference(US Core Patient Profile) | 1..1 | Patient reference this lab was ordered for |
| encounter | Reference(Encounter) | 0..1 | Encounter reference when test ordered |
| effective[x]:effectiveDateTime | dateTime | 1..1 | Specimen Collection Datetime or Period |
| issued | instant | 1..1 | instant |
| performer | Reference(US Core Practitioner Profile | US Core Organization Profile) | 0..* | Organization who is responsible for issuing the report |
| result | Reference(US Core Laboratory Result Observation Profile) | 0..* | Observations made during the lab |
| conclusion | string | 0..1 | Clinical conclusion (interpretation) of test results |
| presentedForm | Attachment | 0..* | Entire report as issued |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | the clinically relevant time of the report |
| identifier | token | an identifier for the report |
| media | reference | a reference to the image source |
| performer | reference | who was the source of the report (organization) |
| code | token | the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| results-interpreter | reference | who was the source of the report |
| subject | reference | the subject of the report |
| diagnosis | token | a coded diagnosis on the report |
| encounter | reference | the encounter when the order was made |
| encounter-class | token | |
| result | reference | link to an atomic result (observation resource) |
| based-on | reference | reference to the procedure request. |
| patient | reference | the subject of the report if a patient |
| specimen | reference | the specimen details |
| context | reference | healthcare event (Episode of Care or Encounter) related to the report |
| issued | date | when the report was issued |
| category | token | which diagnostic discipline/department created the report |
| status | token | the status of the report |
| requester-id | string | |
| _include | undefined | DiagnosticReport:performer |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles
DiagnosticReport Profile for Laboratory Results Reporting
On top of the other constraints, a DiagnosticReport for Laboratory Results Reporting must have:
- one entry in the
categoryarray havingsystem = http://terminology.hl7.org/CodeSystem/v2-0074,code = LAB - the result values should be coded as
Observationentries and referenced in theresultfield
DiagnosticReport
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport
Examples
Using Identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical note"
}
],
"text": "History & Physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/202"
},
"effectiveDateTime": "1958-05-23T01:11:45-04:00",
"issued": "1958-05-23T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
}Using LAB category
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport?category=LAB&patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "6444129f-3766-488e-bdba-e657dff2b180",
"meta": {
"lastUpdated": "2022-11-04T16:03:48.311+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport?category=LAB&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/{{ResourceId}}",
"resource": {
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "LAB",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "51990-0",
"display": "Basic Metabolic Panel"
}
],
"text": "Basic Metabolic Panel"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/744"
},
"effectiveDateTime": "2017-09-28T19:33:18-04:00",
"issued": "2017-09-28T19:33:18.715-04:00",
"performer": [
{
"reference": "Organization/357",
"display": "PCP170967"
},
{
"reference": "Practitioner/358"
},
{
"reference": "Organization/357"
}
],
"result": [
{
"reference": "Observation/745",
"display": "Glucose"
},
{
"reference": "Observation/746",
"display": "Urea Nitrogen"
},
{
"reference": "Observation/747",
"display": "Creatinine"
},
{
"reference": "Observation/748",
"display": "Calcium"
},
{
"reference": "Observation/749",
"display": "Sodium"
},
{
"reference": "Observation/750",
"display": "Potassium"
},
{
"reference": "Observation/751",
"display": "Chloride"
},
{
"reference": "Observation/752",
"display": "Carbon Dioxide"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/814",
"resource": {
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:29.300+00:00",
"source": "#iLFSV7OLv0KF8dmQ",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-lab"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0074",
"code": "LAB",
"display": "Laboratory"
}
]
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "51990-0",
"display": "Basic Metabolic Panel"
}
],
"text": "Basic Metabolic Panel"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/744"
},
"effectivePeriod": {
"start": "2017-09-28T19:33:18-04:00",
"end": "2017-09-28T20:33:18-04:00"
},
"issued": "2017-09-28T19:33:18.715-04:00",
"performer": [
{
"reference": "Organization/357",
"display": "PCP170967"
},
{
"reference": "Practitioner/358"
},
{
"reference": "Organization/357"
}
],
"result": [
{
"reference": "Observation/745",
"display": "Glucose"
},
{
"reference": "Observation/746",
"display": "Urea Nitrogen"
},
{
"reference": "Observation/747",
"display": "Creatinine"
},
{
"reference": "Observation/748",
"display": "Calcium"
},
{
"reference": "Observation/749",
"display": "Sodium"
},
{
"reference": "Observation/750",
"display": "Potassium"
},
{
"reference": "Observation/751",
"display": "Chloride"
},
{
"reference": "Observation/752",
"display": "Carbon Dioxide"
}
]
},
"search": {
"mode": "match"
}
}
]
}DiagnostoicsReport (Report and Note exchange)
Definition : The Diagnostic Report for Report and Note resource is used to fetch diagnostic reports and notes associated with a patient. The resource shall conform to the US Core Diagnostic Report for Report and Note Exchange Profile (v3.1.1: STU3)
Retrieving a patient's laboratory result DiagnosticReport Report and Note exchange
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
DiagnosticReport
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Diagnostic Report for Report and Note resource entry id |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource |
| status | code | 1..1 | Current status of the Diagnostic Report |
| category | CodeableConcept | 1..* | Service category of Diagnostic Report |
| code | CodeableConcept | 1..1 | Code that identifies the Diagnostic Report |
| subject | Reference(US Core Patient Profile) | 1..1 | Patient who is associated with the report |
| encounter | Reference(US Core Encounter Profile) | 0..1 | Encounter reference when test ordered |
| effective[x]:effectiveDateTime | dateTime | 1..1 | Time of the report or note |
| issued | instant | 0..1 | DateTime this version was made |
| performer | Reference(US Core Practitioner Profile | US Core Organization Profile) | 0..* | Organization who is responsible for issuing the report |
| conclusion | string | 0..1 | Clinical conclusion (interpretation) of test results |
| presentedForm | Attachment | 0..* | Entire report as issued |
| result | Reference(Observation) | 0..* | Observations |
Search Parameters
| Name | Type | Description |
|---|---|---|
| date | date | the clinically relevant time of the report |
| identifier | token | an identifier for the report |
| media | reference | a reference to the image source |
| performer | reference | who was the source of the report (organization) |
| code | token | the code for the report as a whole, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
| results-interpreter | reference | who was the source of the report |
| subject | reference | the subject of the report |
| diagnosis | token | a coded diagnosis on the report |
| encounter | reference | the encounter when the order was made |
| encounter-class | token | |
| result | reference | link to an atomic result (observation resource) |
| based-on | reference | reference to the procedure request. |
| patient | reference | the subject of the report if a patient |
| specimen | reference | the specimen details |
| context | reference | healthcare event (Episode of Care or Encounter) related to the report |
| issued | date | when the report was issued |
| category | token | which diagnostic discipline/department created the report |
| status | token | the status of the report |
| requester-id | string | |
| _include | undefined | DiagnosticReport:performer |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles
DiagnosticReport Profile for Report and Note exchange
On top of the other constraints, a DiagnosticReport for Laboratory Results Reporting must have:
- a
codedescribing the type of report from US Core Diagnosticreport Report And Note Codes - a
categorycode from US Core DiagnosticReport Category - a reference to the fullReport (Narrative) in the
presentedFormfield
The system supports the following clinical note categories:
- History & Physical Note (34117-2)
and the following DiagnosticReport categories:
- Cardiology / Laboratory Report (LP29708-2)
- Pathology Report (LP7839-6)
- Radiology / Imaging Narrative (LP29684-5)
DiagnosticReport
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport
Examples
Using Identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical note"
}
],
"text": "History & Physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/202"
},
"effectiveDateTime": "1958-05-23T01:11:45-04:00",
"issued": "1958-05-23T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
}Using Report/Note exchange
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport?patient={{PPG}}&category=LP29684-5
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "0f9fc14a-f548-40dc-855f-82123a9b79b6",
"meta": {
"lastUpdated": "2022-11-04T16:03:17.102+00:00"
},
"type": "searchset",
"total": 7,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport?category=LP29684-5&patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/{{ResourceId}}",
"resource": {
"resourceType": "DiagnosticReport",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Physical note"
}
],
"text": "History & Physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/202"
},
"effectiveDateTime": "1958-05-23T01:11:45-04:00",
"issued": "1958-05-23T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/179",
"resource": {
"resourceType": "DiagnosticReport",
"id": "179",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/175"
},
"effectiveDateTime": "1951-09-04T01:11:45-04:00",
"issued": "1951-09-04T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NTEtMDktMDQKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDExIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZS4KCiMgU29jaWFsIEhpc3RvcnkKIFBhdGllbnQgaGFzIG5ldmVyIHNtb2tlZCBhbmQgaXMgYW4gYWxjb2hvbGljLgoKUGF0aWVudCBjb21lcyBmcm9tIGEgaGlnaCBzb2Npb2Vjb25vbWljIGJhY2tncm91bmQuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgpQYXRpZW50IGlzIHByZXNlbnRpbmcgd2l0aCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4gCgojIyBQbGFuCgpUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQpUaGUgcGF0aWVudCB3YXMgcHJlc2NyaWJlZCB0aGUgZm9sbG93aW5nIG1lZGljYXRpb25zOgotIGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAo="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/221",
"resource": {
"resourceType": "DiagnosticReport",
"id": "221",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/219"
},
"effectiveDateTime": "1961-06-25T01:11:45-04:00",
"issued": "1961-06-25T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NjEtMDYtMjUKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDIxIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDIxLjcgbWcvbWwgLyBkZXh0cm9tZXRob3JwaGFuIGh5ZHJvYnJvbWlkZSAxIG1nL21sIC8gZG94eWxhbWluZSBzdWNjaW5hdGUgMC40MTcgbWcvbWwgb3JhbCBzb2x1dGlvbjsgcGVuaWNpbGxpbiBnIDM3NSBtZy9tbCBpbmplY3RhYmxlIHNvbHV0aW9uOyBhc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0OyBhbW94aWNpbGxpbiAyNTAgbWcgLyBjbGF2dWxhbmF0ZSAxMjUgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgpQYXRpZW50IGlzIHByZXNlbnRpbmcgd2l0aCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLiAKCiMjIFBsYW4KCg=="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/99",
"resource": {
"resourceType": "DiagnosticReport",
"id": "99",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/96"
},
"effectiveDateTime": "1940-09-06T01:11:45-04:00",
"issued": "1940-09-06T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/155",
"resource": {
"resourceType": "DiagnosticReport",
"id": "155",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History and physical note"
}
],
"text": "History and physical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/153"
},
"effectiveDateTime": "1947-03-21T00:11:45-05:00",
"issued": "1947-03-21T00:11:45.131-05:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NDctMDMtMjEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg=="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/255",
"resource": {
"resourceType": "DiagnosticReport",
"id": "255",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/252"
},
"effectiveDateTime": "1971-06-11T01:11:45-04:00",
"issued": "1971-06-11T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NzEtMDYtMTEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDMxIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYWNldGFtaW5vcGhlbiAyMS43IG1nL21sIC8gZGV4dHJvbWV0aG9ycGhhbiBoeWRyb2Jyb21pZGUgMSBtZy9tbCAvIGRveHlsYW1pbmUgc3VjY2luYXRlIDAuNDE3IG1nL21sIG9yYWwgc29sdXRpb247IHBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldDsgYW1veGljaWxsaW4gMjUwIG1nIC8gY2xhdnVsYW5hdGUgMTI1IG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuClBhdGllbnQgd2FzIGdpdmVuIHRoZSBmb2xsb3dpbmcgaW1tdW5pemF0aW9uczogaW5mbHVlbnphLCBzZWFzb25hbCwgaW5qZWN0YWJsZSwgcHJlc2VydmF0aXZlIGZyZWUuIApUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQo="
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DiagnosticReport/123",
"resource": {
"resourceType": "DiagnosticReport",
"id": "123",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-diagnosticreport-note"
]
},
"status": "final",
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "LP29684-5",
"display": "Radiology"
}
],
"text": "Radiology"
}
],
"code": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History & Phsyical note"
}
],
"text": "History & Phsyical note"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/120"
},
"effectiveDateTime": "1941-09-05T01:11:45-04:00",
"issued": "1941-09-05T01:11:45.131-04:00",
"performer": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"presentedForm": [
{
"contentType": "text/plain",
"data": "CjE5NDEtMDktMDUKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDEgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGhhcyBuZXZlciBzbW9rZWQgYW5kIGlzIGFuIGFsY29ob2xpYy4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGN1cnJlbnRseSBoYXMgQmx1ZSBDcm9zcyBCbHVlIFNoaWVsZC4KCiMgQWxsZXJnaWVzCk5vIEtub3duIEFsbGVyZ2llcy4KCiMgTWVkaWNhdGlvbnMKYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgoKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
}
]
},
"search": {
"mode": "match"
}
}
]
}Documentation Reference (C-CDAs)
Definition :The Document Reference resource is used to fetch the documents associated with a patient. The resource shall conform to the US Core Document Reference Profile (v3.1.1: STU3)
Retrieving a patient's CCDA documents
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
DocumentReference
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Document Reference resource entry id. |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource |
| identifier | Identifier | 0..* | Other identifiers for the document |
| status | code | 1..1 | Current status of this document reference |
| type | CodeableConcept | 1..1 | Code that identifies the kind of document (LOINC if possible) |
| category | CodeableConcept | 1..* | Code that identifies the category of document |
| subject | Reference(US Core Patient Profile) | 1..1 | who/what is the subject of the document |
| date | instant | 0..1 | when this document reference was created |
| author | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | 0..* | Practitioner reference who authored the document |
| custodian | Reference(US Core Organization Profile) | 0..1 | organization which maintains the document |
| content | BackboneElement | 1..* | Document referenced |
| context | BackboneElement | 0..* | Encounter reference when this document was created |
Search Parameters
| Name | Type | Description |
|---|---|---|
| securitylabel | token | document security-tags |
| subject | reference | who/what is the subject of the document |
| description | string | human-readable description (title) |
| language | token | human language of the content (BCP-47) |
| type | token | kind of document (LOINC if possible) |
| relation | token | replaces |
| patient | reference | who/what is the subject of the document |
| event | token | main clinical acts documented |
| category | token | categorization of document |
| authenticator | reference | who/what authenticated the document |
| identifier | token | Master Version Specific Identifier |
| period | date | time of service that is being documented |
| custodian | reference | organization which maintains the document |
| author | reference | who and/or what authored the document |
| date | instant | when the document reference was created. |
| format | token | format/content rules for the document |
| encounter | reference | Context of the document content |
| location | uri | URI where the data can be found |
| relatesto | reference | target of the relationship |
| facility | token | kind of facility where patient was seen |
| status | token | current |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles
The DocumentReference type field supports the full US Core DocumentReference Type value set including the following clinical note types and diagnostic report narratives:
- History and physical note (34117-2)
DocumentReference
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:acc9d16d-da9b-9dc9-fbb4-9e6f950b11e6"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1940-09-06T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/96"
}
],
"period": {
"start": "1940-09-06T01:11:45-04:00",
"end": "1940-09-06T01:26:45-04:00"
}
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "86a06cbf-1c74-4e9e-9758-d79b27fbf7c4",
"meta": {
"lastUpdated": "2022-07-28T16:07:56.405+00:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference?patient={{PPG}}"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Binary/patientcentric-9297",
"resource": {
"resourceType": "Binary",
"id": "{{ResourceId}}",
"meta": {
"profile": [
"http://hl7.org/fhir/R4/binary"
]
},
"contentType": "application/xml",
"data": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/PjxDbGluaWNhbERvY3VtZW50IHhtbG5zPSJ1cm46aGw3LW9yZzp2MyIgeG1sbnM6c2R0Yz0idXJuOmhsNy1vcmc6c2R0YyI+PHJlYWxtQ29kZSBjb2RlPSJVUyIvPjx0eXBlSWQgcm9vdD0iMi4xNi44NDAuMS4xMTM4ODMuMS4zIiBleHRlbnNpb249IlBPQ0RfSEQwMDAwNDAiLz48dGVtcGxhdGVJZCByb290PSIyLjE2Ljg0MC4xLjExMzg4My4xMC4yMC4yMi4xLj"
},
"search": {
"mode": "include"
}
},
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/patientcentric-9297",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"lastUpdated": "2022-07-28T12:07:55.530-04:00",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border="1"><tbody><tr><td>Status</td><td><span>CURRENT</span></td></tr><tr><td>DocumentReference Type</td><td><span>34133-9</span></td></tr><tr><td>DocumentReference Type Name</td><td><span>Summary of episode note</span></td></tr><tr><td>Created Date</td><td><span>28 July 2022</span></td></tr></tbody></table></div>"
},
"identifier": [
{
"system": "urn:oid:2.16.840.1.113883.4.391",
"value": "patientcentric-9297"
}
],
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34133-9",
"display": "Summary of episode note"
}
],
"text": "CCD Document"
},
"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/9297",
"type": "Patient"
},
"date": "2022-07-28T12:07:55.530-04:00",
"author": [
{
"reference": "Organization/2.16.840.1.113883.4.391",
"type": "Organization"
}
],
"custodian": {
"reference": "Organization/2.16.840.1.113883.4.391",
"type": "Organization"
},
"content": [
{
"attachment": {
"contentType": "application/xml",
"url": "Binary/patientcentric-9297"
}
},
"format": {
"system": "urn:oid:1.3.6.1.4.1.19376.1.2.3",
"code": "urn:hl7-org:sdwg:ccda-structuredBody:2.1",
"display": "Documents following C-CDA constraints using a structured body"
}
]
},
"search": {
"mode": "match"
}
}
]
}
Document Reference (Clinical Notes)
Definition : The Document Reference resource is used to fetch the clinical notes associated with a patient. The resource shall conform to the US Core Document Reference Profile (v3.1.1: STU3)
Retrieving a patient's encounters
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Document Reference resource entry id. |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource |
| identifier | Identifier | 0..* | Other identifiers for the document |
| status | code | 1..1 | Current status of this document reference |
| type | CodeableConcept | 1..1 | Code that identifies the kind of document (LOINC if possible) |
| category | CodeableConcept | 1..* | Code that identifies the category of document |
| subject | Reference(US Core Patient Profile) | 1..1 | Who/what is the subject of the document |
| date | instant | 0..1 | When this document reference was created |
| author | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | 0..* | Practitioner reference who authored the document |
| custodian | Reference(US Core Organization Profile) | 0..1 | Organization which maintains the document |
| content | BackboneElement | 1..* | Document referenced |
| context | BackboneElement | 0..1 | Encounter reference when this document was created |
Search Parameters
| Name | Type | Description |
|---|---|---|
| securitylabel | token | document security-tags |
| subject | reference | who/what is the subject of the document |
| description | string | human-readable description (title) |
| language | token | human language of the content (BCP-47) |
| type | token | kind of document (LOINC if possible) |
| relation | token | replaces |
| patient | reference | who/what is the subject of the document |
| event | token | main clinical acts documented |
| category | token | categorization of document |
| authenticator | reference | who/what authenticated the document |
| identifier | token | Master Version Specific Identifier |
| period | date | time of service that is being documented |
| custodian | reference | organization which maintains the document |
| author | reference | who and/or what authored the document |
| date | instant | when the document reference was created. |
| format | token | format/content rules for the document |
| encounter | reference | Context of the document content |
| location | uri | URI where the data can be found |
| relatesto | reference | target of the relationship |
| facility | token | kind of facility where patient was seen |
| status | token | current |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Profiles
The DocumentReference type field supports the full US Core DocumentReference Type value set including the following clinical note types and diagnostic report narratives:
- History and physical note (34117-2)
DocumentReference
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:acc9d16d-da9b-9dc9-fbb4-9e6f950b11e6"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1940-09-06T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/96"
}
],
"period": {
"start": "1940-09-06T01:11:45-04:00",
"end": "1940-09-06T01:26:45-04:00"
}
}
}Using search parameter
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "66ba2cda-637b-4763-88f7-29f30599a693",
"meta": {
"lastUpdated": "2022-11-04T16:03:19.593+00:00"
},
"type": "searchset",
"total": 20,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference?patient={{PPG}}"
},
{
"relation": "next",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}?_getpages=66ba2cda-637b-4763-88f7-29f30599a693&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/{{ResourceId}}",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:acc9d16d-da9b-9dc9-fbb4-9e6f950b11e6"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1940-09-06T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDAtMDktMDYKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDUgbW9udGgtb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCk5vIEFjdGl2ZSBNZWRpY2F0aW9ucy4KCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/96"
}
],
"period": {
"start": "1940-09-06T01:11:45-04:00",
"end": "1940-09-06T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/180",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:4fcadab6-9d33-a2f7-1657-9b1fdf79b7bf"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "57133-1",
"display": "Referral note"
}
],
"text": "Referral note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1951-09-04T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"custodian": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTEtMDktMDQKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDExIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZS4KCiMgU29jaWFsIEhpc3RvcnkKIFBhdGllbnQgaGFzIG5ldmVyIHNtb2tlZCBhbmQgaXMgYW4gYWxjb2hvbGljLgoKUGF0aWVudCBjb21lcyBmcm9tIGEgaGlnaCBzb2Npb2Vjb25vbWljIGJhY2tncm91bmQuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgpQYXRpZW50IGlzIHByZXNlbnRpbmcgd2l0aCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4gCgojIyBQbGFuCgpUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQpUaGUgcGF0aWVudCB3YXMgcHJlc2NyaWJlZCB0aGUgZm9sbG93aW5nIG1lZGljYXRpb25zOgotIGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAo="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/175"
}
],
"period": {
"start": "1951-09-04T01:11:45-04:00",
"end": "1951-09-04T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/206",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:eb75e932-f3b5-1482-e142-0e31c97b4f95"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11488-4",
"display": "Consultation note"
}
],
"text": "Consultation note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1958-05-23T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTgtMDUtMjMKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE4IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwpwZW5pY2lsbGluIGcgMzc1IG1nL21sIGluamVjdGFibGUgc29sdXRpb247IGFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQ7IGFtb3hpY2lsbGluIDI1MCBtZyAvIGNsYXZ1bGFuYXRlIDEyNSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAKVGhlIGZvbGxvd2luZyBwcm9jZWR1cmVzIHdlcmUgY29uZHVjdGVkOgotIG1lZGljYXRpb24gcmVjb25jaWxpYXRpb24gKHByb2NlZHVyZSkK"
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/202"
}
],
"period": {
"start": "1958-05-23T01:11:45-04:00",
"end": "1958-05-23T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/156",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:d7130c41-5c6c-b632-dd67-1ba7468f17c2"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History and physical note"
}
],
"text": "History and physical note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1947-03-21T00:11:45.131-05:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDctMDMtMjEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/153"
}
],
"period": {
"start": "1947-03-21T00:11:45-05:00",
"end": "1947-03-21T00:26:45-05:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/256",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:15ad0f57-f7c3-2dec-0db4-feccdc3245d2"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11504-8",
"display": "Surgical operation note"
}
],
"text": "Surgical operation note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1971-06-11T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NzEtMDYtMTEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDMxIHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYWNldGFtaW5vcGhlbiAyMS43IG1nL21sIC8gZGV4dHJvbWV0aG9ycGhhbiBoeWRyb2Jyb21pZGUgMSBtZy9tbCAvIGRveHlsYW1pbmUgc3VjY2luYXRlIDAuNDE3IG1nL21sIG9yYWwgc29sdXRpb247IHBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldDsgYW1veGljaWxsaW4gMjUwIG1nIC8gY2xhdnVsYW5hdGUgMTI1IG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuClBhdGllbnQgd2FzIGdpdmVuIHRoZSBmb2xsb3dpbmcgaW1tdW5pemF0aW9uczogaW5mbHVlbnphLCBzZWFzb25hbCwgaW5qZWN0YWJsZSwgcHJlc2VydmF0aXZlIGZyZWUuIApUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gbWVkaWNhdGlvbiByZWNvbmNpbGlhdGlvbiAocHJvY2VkdXJlKQo="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/252"
}
],
"period": {
"start": "1971-06-11T01:11:45-04:00",
"end": "1971-06-11T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/276",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:6f01c40c-3b4d-bb63-d997-950dc7f43ab9"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34746-8",
"display": "Nurse Note"
}
],
"text": "Nurse Note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1975-04-07T02:42:45.131-04:00",
"author": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"custodian": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NzUtMDQtMDcKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDM1IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDMyNSBtZyBvcmFsIHRhYmxldDsgYWNldGFtaW5vcGhlbiAyMS43IG1nL21sIC8gZGV4dHJvbWV0aG9ycGhhbiBoeWRyb2Jyb21pZGUgMSBtZy9tbCAvIGRveHlsYW1pbmUgc3VjY2luYXRlIDAuNDE3IG1nL21sIG9yYWwgc29sdXRpb247IHBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldDsgZnVyb3NlbWlkZSA0MCBtZyBvcmFsIHRhYmxldDsgYW1veGljaWxsaW4gMjUwIG1nIC8gY2xhdnVsYW5hdGUgMTI1IG1nIG9yYWwgdGFibGV0CgojIEFzc2Vzc21lbnQgYW5kIFBsYW4KCgojIyBQbGFuCgpUaGUgZm9sbG93aW5nIHByb2NlZHVyZXMgd2VyZSBjb25kdWN0ZWQ6Ci0gb3h5Z2VuIGFkbWluaXN0cmF0aW9uIGJ5IG1hc2sgKHByb2NlZHVyZSkKLSBwbGFjaW5nIHN1YmplY3QgaW4gcHJvbmUgcG9zaXRpb24gKHByb2NlZHVyZSkKLSBwbGFpbiBjaGVzdCB4LXJheSAocHJvY2VkdXJlKQo="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/273"
}
],
"period": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-07T03:42:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/218",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:3a79a6cf-302f-32b5-42f7-44f471c2cbbc"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34117-2",
"display": "History and physical note"
}
],
"text": "History and physical note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1959-05-29T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTktMDUtMjkKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE5IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2YgYWN1dGUgYnJvbmNoaXRpcyAoZGlzb3JkZXIpLCBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLCB2aXJhbCBzaW51c2l0aXMgKGRpc29yZGVyKS4KCiMgU29jaWFsIEhpc3RvcnkKUGF0aWVudCBpcyBtYXJyaWVkLiBQYXRpZW50IGlzIGFuIGFjdGl2ZSBzbW9rZXIgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGhhcyBjb21wbGV0ZWQgc29tZSBjb2xsZWdlIGNvdXJzZXMuIFBhdGllbnQgY3VycmVudGx5IGhhcyBCbHVlIENyb3NzIEJsdWUgU2hpZWxkLgoKIyBBbGxlcmdpZXMKTm8gS25vd24gQWxsZXJnaWVzLgoKIyBNZWRpY2F0aW9ucwphY2V0YW1pbm9waGVuIDIxLjcgbWcvbWwgLyBkZXh0cm9tZXRob3JwaGFuIGh5ZHJvYnJvbWlkZSAxIG1nL21sIC8gZG94eWxhbWluZSBzdWNjaW5hdGUgMC40MTcgbWcvbWwgb3JhbCBzb2x1dGlvbjsgcGVuaWNpbGxpbiBnIDM3NSBtZy9tbCBpbmplY3RhYmxlIHNvbHV0aW9uOyBhc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0OyBhbW94aWNpbGxpbiAyNTAgbWcgLyBjbGF2dWxhbmF0ZSAxMjUgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/214"
}
],
"period": {
"start": "1959-05-29T01:11:45-04:00",
"end": "1959-05-29T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/152",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:95f2314e-8bd2-bb55-dc66-6d733185d60e"
}
],
"status": "superseded",
"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"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1947-01-22T01:11:45.131-05:00",
"author": [
{
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
}
],
"custodian": {
"reference": "Organization/104",
"display": "LOWELL GENERAL HOSPITAL"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDctMDEtMjIKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDYgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCmFzcGlyaW4gODEgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/150"
}
],
"period": {
"start": "1947-01-22T01:11:45-05:00",
"end": "1947-01-22T01:26:45-05:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/168",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:2536ace1-6f55-5495-bd52-3937e0f63a13"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "11506-3",
"display": "Progress note"
}
],
"text": "Progress note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1949-04-01T00:11:45.131-05:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NDktMDQtMDEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDkgeWVhci1vbGQgbm9uLWhpc3BhbmljIHdoaXRlIG1hbGUuIFBhdGllbnQgaGFzIGEgaGlzdG9yeSBvZiBvdGl0aXMgbWVkaWEsIGFjdXRlIHZpcmFsIHBoYXJ5bmdpdGlzIChkaXNvcmRlciksIGZyYWN0dXJlIG9mIGNsYXZpY2xlLgoKIyBTb2NpYWwgSGlzdG9yeQogUGF0aWVudCBoYXMgbmV2ZXIgc21va2VkIGFuZCBpcyBhbiBhbGNvaG9saWMuCgpQYXRpZW50IGNvbWVzIGZyb20gYSBoaWdoIHNvY2lvZWNvbm9taWMgYmFja2dyb3VuZC4gUGF0aWVudCBjdXJyZW50bHkgaGFzIEJsdWUgQ3Jvc3MgQmx1ZSBTaGllbGQuCgojIEFsbGVyZ2llcwpObyBLbm93biBBbGxlcmdpZXMuCgojIE1lZGljYXRpb25zCnBlbmljaWxsaW4gZyAzNzUgbWcvbWwgaW5qZWN0YWJsZSBzb2x1dGlvbjsgYXNwaXJpbiA4MSBtZyBvcmFsIHRhYmxldAoKIyBBc3Nlc3NtZW50IGFuZCBQbGFuCgoKIyMgUGxhbgpQYXRpZW50IHdhcyBnaXZlbiB0aGUgZm9sbG93aW5nIGltbXVuaXphdGlvbnM6IGluZmx1ZW56YSwgc2Vhc29uYWwsIGluamVjdGFibGUsIHByZXNlcnZhdGl2ZSBmcmVlLiAK"
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/165"
}
],
"period": {
"start": "1949-04-01T00:11:45-05:00",
"end": "1949-04-01T00:26:45-05:00"
}
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/DocumentReference/198",
"resource": {
"resourceType": "DocumentReference",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference"
]
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:uuid:393d97e4-f301-e7d8-9332-778dbc75e751"
}
],
"status": "superseded",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34746-8",
"display": "Nurse Note"
}
],
"text": "Nurse Note"
},
"category": [
{
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-documentreference-category",
"code": "clinical-note",
"display": "Clinical Note"
}
]
}
],
"subject": {
"reference": "Patient/{{PPG}}"
},
"date": "1956-05-11T01:11:45.131-04:00",
"author": [
{
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
}
],
"custodian": {
"reference": "Organization/87",
"display": "PCP87052"
},
"content": [
{
"attachment": {
"contentType": "text/plain",
"data": "CjE5NTYtMDUtMTEKCiMgQ2hpZWYgQ29tcGxhaW50Ck5vIGNvbXBsYWludHMuCgojIEhpc3Rvcnkgb2YgUHJlc2VudCBJbGxuZXNzCkx1Y2llbjQwOCBpcyBhIDE2IHllYXItb2xkIG5vbi1oaXNwYW5pYyB3aGl0ZSBtYWxlLiBQYXRpZW50IGhhcyBhIGhpc3Rvcnkgb2Ygb3RpdGlzIG1lZGlhLCBhY3V0ZSB2aXJhbCBwaGFyeW5naXRpcyAoZGlzb3JkZXIpLCBmcmFjdHVyZSBvZiBjbGF2aWNsZSwgdmlyYWwgc2ludXNpdGlzIChkaXNvcmRlcikuCgojIFNvY2lhbCBIaXN0b3J5CiBQYXRpZW50IGhhcyBuZXZlciBzbW9rZWQgYW5kIGlzIGFuIGFsY29ob2xpYy4gUGF0aWVudCBpZGVudGlmaWVzIGFzIGhldGVyb3NleHVhbC4KClBhdGllbnQgY29tZXMgZnJvbSBhIGhpZ2ggc29jaW9lY29ub21pYyBiYWNrZ3JvdW5kLiBQYXRpZW50IGN1cnJlbnRseSBoYXMgQmx1ZSBDcm9zcyBCbHVlIFNoaWVsZC4KCiMgQWxsZXJnaWVzCk5vIEtub3duIEFsbGVyZ2llcy4KCiMgTWVkaWNhdGlvbnMKcGVuaWNpbGxpbiBnIDM3NSBtZy9tbCBpbmplY3RhYmxlIHNvbHV0aW9uOyBhc3BpcmluIDgxIG1nIG9yYWwgdGFibGV0OyBhbW94aWNpbGxpbiAyNTAgbWcgLyBjbGF2dWxhbmF0ZSAxMjUgbWcgb3JhbCB0YWJsZXQKCiMgQXNzZXNzbWVudCBhbmQgUGxhbgoKCiMjIFBsYW4KUGF0aWVudCB3YXMgZ2l2ZW4gdGhlIGZvbGxvd2luZyBpbW11bml6YXRpb25zOiBpbmZsdWVuemEsIHNlYXNvbmFsLCBpbmplY3RhYmxlLCBwcmVzZXJ2YXRpdmUgZnJlZS4gClRoZSBmb2xsb3dpbmcgcHJvY2VkdXJlcyB3ZXJlIGNvbmR1Y3RlZDoKLSBtZWRpY2F0aW9uIHJlY29uY2lsaWF0aW9uIChwcm9jZWR1cmUpCg=="
},
"format": {
"system": "http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem",
"code": "urn:ihe:iti:xds:2017:mimeTypeSufficient",
"display": "mimeType Sufficient"
}
}
],
"context": {
"encounter": [
{
"reference": "Encounter/195"
}
],
"period": {
"start": "1956-05-11T01:11:45-04:00",
"end": "1956-05-11T01:26:45-04:00"
}
}
},
"search": {
"mode": "match"
}
}
]
}Medication Administration (Medications)
Definition : The Medication Administration resource is used to fetch the administered medications associated with a patient. The resource shall conform to the US Core Medication Administration Profile (R4)
Retrieving a patient's vitals
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Medication Administration
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | id | 0..1 | Medication Administration resource entry id. |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource |
| status | code | 1..1 | Current status of Medication Administration |
| statusReason | CodeableConcept | 0..* | Reason administration not performed |
| medication[x]:medicationCodeableConcept | CodeableConcept | 1..1 | Medication that was administered |
| subject | Reference(Patient | Group) | 1..1 | Patient who received medication |
| context | Reference(Encounter | EpisodeOfCare) | 0..1 | Encounter reference this medication is administered as part of |
| effective[x]:effectiveDateTime | dateTime | 1..1 | Start and end time of administration |
| performer | BackboneElement | 0..* | Practitioner reference who performed the medication administration |
| note | Annotation | 0..* | Information about the administration |
| dosage | BackboneElement | 0..1 | Details of how medication was taken |
Search Parameters
| Name | Type | Description |
|---|---|---|
| authoredon | date | Return prescriptions written on this date |
| date | date | returns medication request to be administered on a specific date |
| identifier | token | return prescriptions with this external identifier |
| intent | token | returns prescriptions with different intents |
| medication | reference | return prescriptions of this medication reference |
| patient | reference | returns prescriptions for a specific patient |
| status | token | status of the prescription |
| subject | reference | the identity of a patient to list orders for |
| _include | undefined | MedicationRequest:medication |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Medication Administration
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "MedicationAdministration",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationAdministration"
]
},
"status": "active",
"intent": "order",
"medicationAdministration": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration?intent=order&patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "6b27b03d-4bc5-4f5e-851c-fcbef7560373",
"meta": {
"lastUpdated": "2022-08-22T10:46:38.382-05:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration?intent=order&patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration/{{ResourceId}}",
"resource": {
"resourceType": "MedicationAdministration",
"id": "{{ResourceId}}",
"meta": {
"lastUpdated": "2022-08-29T09:50:20.243-04:00",
"profile": [
"http://hl7.org/fhir/R4/medicationadministration"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\\"http://www.w3.org/1999/xhtml\\"><table border=\\"1\\"><tbody><tr><td>Status</td><td><span>COMPLETED</span></td></tr><span><tr/></span><span><tr><td>MedicationAdministration Display</td><td><span>Aimovig</span></td></tr></span><tr><td>Effective Date</td><td><span>29 August 2022</span></td></tr></tbody></table></div>"
},
"status": "completed",
"medicationCodeableConcept": {
"text": "Aimovig"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"context": {
"reference": "Encounter/277",
"type": "Encounter"
},
"effectiveDateTime": "2022-08-29T09:49:00-04:00"
"performer": [
{
"actor": {
"reference": "Practitioner/105",
"type": "Practitioner"
}
}
],
"dosage": {
"text": "Aimovig: 5 mL Intradermal given by Willis, Sam M on",
"route": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "372464004",
"display": "Intradermal use"
}
]
,
"text": "Intradermal"
},
"method": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "422145002",
"display": "Inject"
}
]
,
"text": "Inject"
},
"dose": {
"value": 5.0,
"unit": "mL",
"system": "http://unitsofmeasure.org",
"code": "mL"
}
},
"search": {
"mode": "match"
}
}
]
}Medication Administration (Therapeutic Injections)
Definition : The Medication Administration resource is used to fetch the therapeutic injections associated with a patient. The resource shall conform to the US Core Medication Administration Profile (R4).
Retrieving a patient's vitals
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Medication Administration (Therapeutic Injections)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | id | 0..1 | Medication Administration resource entry id. |
| meta | Meta | 0..1 | Metadata(profile and last updated date/time) about the resource |
| status | code | 1..1 | Current status of Medication Administration |
| statusReason | CodeableConcept | 0..* | Reason administration not performed |
| medication[x]:medicationCodeableConcept | CodeableConcept | 1..1 | Medication that was administered |
| subject | Reference(Patient | Group) | 1..1 | Patient who received medication |
| context | Reference(Encounter | EpisodeOfCare) | 0..1 | Encounter reference this medication is administered as part of |
| effective[x]:effectiveDateTime | dateTime | 1..1 | Start and end time of administration |
| performer | BackboneElement | 0..* | Practitioner reference who performed the medication administration |
| note | Annotation | 0..* | Information about the administration |
| dosage | BackboneElement | 0..1 | Details of how medication was taken |
Search Parameters
| Name | Type | Description |
|---|---|---|
| authoredon | date | Return prescriptions written on this date |
| date | date | returns medication request to be administered on a specific date |
| identifier | token | return prescriptions with this external identifier |
| intent | token | returns prescriptions with different intents |
| medication | reference | return prescriptions of this medication reference |
| patient | reference | returns prescriptions for a specific patient |
| status | token | status of the prescription |
| subject | reference | the identity of a patient to list orders for |
| _include | undefined | MedicationRequest:medication |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Medication Administration
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "MedicationAdministration",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationAdministration"
]
},
"status": "active",
"intent": "order",
"medicationAdministration": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration?intent=order&patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "6b27b03d-4bc5-4f5e-851c-fcbef7560373",
"meta": {
"lastUpdated": "2022-08-22T10:46:38.382-05:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration?intent=order&patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationAdministration/{{ResourceId}}",
"resource": {
"resourceType": "MedicationAdministration",
"id": "Hig.kpDnjkh0tsiuhy137iAYt-l9lPkbBokgFZt3jeCWiYSViDysGrmOxSTgu.QJ",
"meta": {
"lastUpdated": "2022-08-29T09:50:36.177-04:00",
"profile": [
"http://hl7.org/fhir/R4/medicationadministration"
]
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><table border="1"><tbody><tr><td>Status</td><td><span>NOTDONE</span></td></tr><tr><td>Status Reason Code</td><td><span>RELIG</span></td></tr><span><tr><td>Status Reason Name</td><td><span>religious objection</span></td></tr></span><tr><td>MedicationAdministration Code</td><td><span>00378-5813-77</span></td></tr><span><tr><td>MedicationAdministration Display</td><td><span>CPTInjection</span></td></tr></span><tr><td>Effective Date</td><td><span>29 August 2022</span></td></tr></tbody></table></div>"
},
"status": "not-done",
"statusReason": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
"code": "RELIG",
"display": "religious objection"}
]
}
],
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls",
"code": "00378-5813-77",
"display": "CPTInjection"
}
]
},
"effectiveDateTime": "2022-08-29T00:00:00-04:00",
{
"performer": [
{
"actor": {
"reference": "Practitioner/Hig.kpDnjkh0tsiuhy137jzjn59CdXy0ehE4NkIzGFc",
"type": "Practitioner"}
}
],
"dosage": {
"text": "CPTInjection: (Refused Religious exemption)",
"method": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "422145002",
"display": "Inject"
}
],
"text": "Inject"
}
},
"search": {
"mode": "match"
}
}
}Medication Request
Definition : The Medication Request resource is used to fetch the requested medications associated with a patient. The resource shall conform to the US Core Medication Request Profile (v3.1.1: STU3)
Retrieving a patient's medications
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** This API does not use date range to filter. **
Medication Request
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Medication Request resource entry id. |
| meta | Meta | 0..1 | Metadata (profile and last updated date/time) about the resource |
| status | code | 1..1 | Current status of medication request |
| intent | code | 1..1 | Kind of medication request |
| reported[x]:reportedBoolean | boolean | 0..1 | Indicates the source of the report |
| medication[x]:medicationReference | Reference(US Core Medication Profile) | 1..1 | Medication to be taken |
| subject | Reference(US Core Patient Profile) | 1..1 | Who or group this medication request is for |
| encounter | Reference(Encounter) | 0..1 | Encounter reference this medication request is created as a part of |
| authoredOn | dateTime | 1..1 | When request was initially authored |
| requester | Reference(US Core Practitioner Profile | US Core Organization Profile | US Core Patient Profile) | 1..1 | Practitioner reference who requested the Request |
| note | Annotation | 0..* | Information about the prescription |
| dosageInstruction | Dosage | 0..* | How the medication should be taken |
| dispenseRequest | BackboneElement | 0..1 | Indicates the specific details for dispense of a medication request. |
Search Parameters
| Name | Type | Description |
|---|---|---|
| authoredon | date | Return prescriptions written on this date |
| date | date | returns medication request to be administered on a specific date |
| identifier | token | return prescriptions with this external identifier |
| intent | token | returns prescriptions with different intents |
| medication | reference | return prescriptions of this medication reference |
| patient | reference | returns prescriptions for a specific patient |
| status | token | status of the prescription |
| subject | reference | the identity of a patient to list orders for |
| _include | undefined | MedicationRequest:medication |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
MedicationRequest
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationRequest
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationRequest/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "MedicationRequest",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"medicationReference": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationRequest?intent=order&patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "e25ef91a-e70f-412e-af57-d1f9b761d03c",
"meta": {
"lastUpdated": "2022-11-04T16:03:23.675+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationRequest?intent=order&patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationRequest/{{ResourceId}}",
"resource": {
"resourceType": "MedicationRequest",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"medicationReference": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/MedicationRequest/{{ResourceId}}",
"resource": {
"resourceType": "MedicationRequest",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medicationrequest"
]
},
"status": "active",
"intent": "order",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "313988",
"display": "Furosemide 40 MG Oral Tablet"
}
],
"text": "Furosemide 40 MG Oral Tablet"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/308"
},
"authoredOn": "1977-05-13T01:11:45-04:00",
"requester": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
},
"reasonReference": [
{
"reference": "Condition/260"
}
],
"dosageInstruction": [
{
"sequence": 1,
"text": "Take as needed.",
"asNeededBoolean": true
}
]
},
"search": {
"mode": "match"
}
}
]
}Medication
Definition : The Medication resource is used to fetch the medication associated to the medication request for a patient. The resource shall conform to the US Core Medication Profile (v3.1.1: STU3)
Retrieving a patient's vitals
The Patient's ID retrieved from Centralized Patient Database will be passed as a part of the URL. ** The Dates for filtering will use the visit dates only. **
Medication
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Medication resource entry id. |
| meta | Meta | 0..1 | Metadata (profile and last updated date/time) about the resource |
| code | CodeableConcept | 1..1 | RxNorm/NDC code for the medication |
Search Parameters
| Name | Type | Description |
|---|---|---|
| authoredon | date | Return prescriptions written on this date |
| date | date | returns medication request to be administered on a specific date |
| identifier | token | return prescriptions with this external identifier |
| intent | token | returns prescriptions with different intents |
| medication | reference | return prescriptions of this medication reference |
| patient | reference | returns prescriptions for a specific patient |
| status | token | status of the prescription |
| subject | reference | the identity of a patient to list orders for |
| _include | undefined | MedicationRequest:medication |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Medication
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Medication
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Medication/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Medication",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
]
},
"status": "active",
"intent": "order",
"medicationReference": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
}Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Medication?intent=order&patient={{PPG}}&status=active
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "e25ef91a-e70f-412e-af57-d1f9b761d03c",
"meta": {
"lastUpdated": "2022-11-04T16:03:23.675+00:00"
},
"type": "searchset",
"total": 2,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Medication?intent=order&patient={{PPG}}&status=active"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Medication/{{ResourceId}}",
"resource": {
"resourceType": "Medication",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
]
},
"status": "active",
"intent": "order",
"medication": {
"reference": "Medication/281"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/277"
},
"authoredOn": "1975-04-07T02:51:45-04:00",
"requester": {
"reference": "Practitioner/105",
"display": "Dr. Willena258 Oberbrunner298"
},
"reasonReference": [
{
"reference": "Condition/260"
}
]
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Medication/{{ResourceId}}",
"resource": {
"resourceType": "Medication",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-medication"
]
},
"status": "active",
"intent": "order",
"medicationCodeableConcept": {
"coding": [
{
"system": "http://www.nlm.nih.gov/research/umls/rxnorm",
"code": "313988",
"display": "Furosemide 40 MG Oral Tablet"
}
],
"text": "Furosemide 40 MG Oral Tablet"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/308"
},
"authoredOn": "1977-05-13T01:11:45-04:00",
"requester": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
},
"reasonReference": [
{
"reference": "Condition/260"
}
],
"dosageInstruction": [
{
"sequence": 1,
"text": "Take as needed.",
"asNeededBoolean": true
}
]
},
"search": {
"mode": "match"
}
}
]
}Organization (EMR)
Definition : A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.
Overview
Organization is used for a collections of people that have come together to achieve an objective. It may be used in a shared registry of contact and other information for various organizations or it can be used merely as a support for other resources that need to reference organizations. This profile is used to define the content that will be returned by the API Server in response to requests to access Organization resources. All elements described in the Definition and Detailed Definitions below are supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.
Organization (EMR)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Organization resource entry id |
| meta | Meta | 0..1 | Metadata(profile) about the resource |
| identifier | (Slice Definition) | 0..* | Identifier associated with this organization across multiple systems |
| active | boolean | 1..1 | Whether the organization's record is still in active use |
| name | string | 1..1 | Name used for the organization |
| telecom | ContactPoint | 0..* | A contact detail for the organization |
| address | Address | 0..* | An address for the organization |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | any identifier for the organization (not the accreditation issuer's identifier) |
| partof | reference | an organization of which this organization forms a part |
| address | string | a (part of the) address of the organization |
| address-state | string | a state specified in an address |
| active | token | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| type | token | a code for the type of organization |
| address-postalcode | string | a postal code specified in an address |
| name | string | a portion of the organization's name or alias |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Organization
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Organization",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"identifier": [
{
"system": "https://github.com/synthetichealth/synthea",
"value": "56090ab7-1f97-37ff-a434-194f9c6e5510"
},
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9999999999"
},
{
"system": "urn:oid:2.16.840.1.113883.4.7",
"value": "9999999999"
}
],
"active": true,
"type": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/organization-type",
"code": "prov",
"display": "Healthcare Provider"
}
],
"text": "Healthcare Provider"
}
],
"name": "PCP87052",
"telecom": [
{
"system": "phone",
"value": "(555) 555-5555"
}
],
"address": [
{
"line": [
"1540 BRIDGE ST"
],
"city": "DRACUT",
"state": "MA",
"postalCode": "01826-2611",
"country": "US"
}
]
}Organization (Performing Labs)
Definition : The Organization resource is used to fetch lab organization associated with a patient or practitioner. The resource shall conform to the US Core Organization Profile (v3.1.1: STU3).
Organization (Performing Labs)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Organization resource entry id. |
| meta | Meta | 0..1 | Metadata(profile) about the resource |
| identifier | (Slice Definition) | 0..* | Identifier associated with this organization across multiple systems |
| active | boolean | 1..1 | Whether the organization's record is still in active use |
| name | string | 1..1 | Name used for the organization |
| telecom | ContactPoint | 0..* | A contact detail for the organization |
| address | Address | 0..* | An address for the organization |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | any identifier for the organization (not the accreditation issuer's identifier) |
| partof | reference | an organization of which this organization forms a part |
| address | string | a (part of the) address of the organization |
| address-state | string | a state specified in an address |
| active | token | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| type | token | a code for the type of organization |
| address-postalcode | string | a postal code specified in an address |
| name | string | a portion of the organization's name or alias |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Organization
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "605a1640-4388-4371-885a-bd4be9edbe3f",
"meta": {
"lastUpdated": "2023-11-21T07:49:44.135-05:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization/{{ResourceId}}",
"resource": {
"resourceType": "Organization",
"id": "Lt2IFR5Ah76n4d8TFP5gBPMFWGL8HhxnxooU.mnA.n5.Xl5yXZN1TQgZByeKFIIZ",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><table border="1"><tbody><tr><td>Name</td><td><span>Test Facility</span></td></tr><tr><td>Address</td><td><div class="hapiHeaderText"><span>2 technology drive</span><br/><span>westboro</span><span>MA</span><span>US</span></div></td></tr><span><tr><td>Telecom Value</td><td><span>508-475-0600</span></td></tr></span></tbody></table></div>"
},"identifier": [
{
"system": "urn:oid:2.16.840.1.113883.4.391",
"value": "Lt2IFR5Ah76n4d8TFP5gBKX0VTjWZgmEqh9kDaB8-RI"
},
"address": [
{
"line": [
"2 technology drive"
],
"city": "westboro",
"state": "MA",
"postalCode": "01581",
"country": "US"
}
]
},
"search": {
"mode": "match"
}
}
]
}
Practitioner
Definition : The Practitioner resource is used to fetch basic demographic details associated with a practitioner. The resource shall conform to the US Core Practitioner Profile (v3.1.1: STU3).
Practitioner
Resource Content
| Name | Type | Type | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | an identifier for the person as this agent (see Profiles for details) |
| active | boolean | 0..1 | whether this practitioner's record is in active use |
| whether this practitioner's record is in active use | HumanName | 1..* | the name(s) associated with the practitioner |
| name.family | string | 1..1 | family name (often called 'Surname') |
| telecom | ContactPoint | 0..* | a contact detail for the practitioner (that apply to all roles) |
| address | Address | 0..* | address(es) of the practitioner that are not role specific (typically home address) |
| gender | code | 0..1 | male |
| birthDate | date | 0..1 | the date on which the practitioner was born |
| photo | Attachment | 0..* | image of the person |
| qualification | BackboneElement | 0..* | qualifications obtained by training and certification |
| communication | CodeableConcept | 0..* | a language the practitioner is able to use in patient communication |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | a practitioner's Identifier |
| given | string | a portion of the given name |
| address | string | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| address-state | string | a state specified in an address |
| gender | token | gender of the practitioner |
| active | token | whether the practitioner record is active |
| address-postalcode | string | a postalCode specified in an address |
| name | string | a server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| telecom | token | the value in any kind of contact |
| family | string | a portion of the family name |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Practitioner
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Practitioner
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Practitioner/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Practitioner",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner"
]
},
"identifier": [
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "9999958969"
}
],
"active": true,
"name": [
{
"family": "Torp761",
"given": [
"Melvin857"
],
"prefix": [
"Dr."
]
}
],
"telecom": [
{
"extension": [
{
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-direct",
"valueBoolean": true
}
],
"system": "email",
"value": "Melvin857.Torp761@example.com",
"use": "work"
}
],
"address": [
{
"line": [
"1540 BRIDGE ST"
],
"city": "DRACUT",
"state": "MA",
"postalCode": "01826-2611",
"country": "US"
}
],
"gender": "female"
}
Practitioner Role
Definition : The Practitioner Role resource is used to fetch role associated with a practitioner. The resource shall conform to the US Core Practitioner Role Profile (v3.1.1: STU3).
Practitioner Role
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Practitioner Role resource entry id |
| meta | Meta | 0..1 | Metadata(profile) about the resource |
| identifier | (Slice Definition) | 1..3 | An identifier for the practioner |
| active | boolean | 0..1 | Whether this practitioner role record is in active use |
| practitioner | Reference(US Core Practitioner Profile) | 1..1 | Practitioner reference this role is associated to |
| organization | Reference(US Core Organization Profile) | 1..1 | Organization where the roles are available |
| code | CodeableConcept | 0..* | Code that identifies this practitioner role |
| specialty | CodeableConcept | 0..* | Code that specifies specialty of the practitioner |
| location | Reference(Location) | 0..* | The location(s) at which this practitioner provides care |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | a practitioner's Identifier |
| given | string | a portion of the given name |
| address | string | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| address-state | string | a state specified in an address |
| gender | token | gender of the practitioner |
| active | token | whether the practitioner record is active |
| address-postalcode | string | a postalCode specified in an address |
| name | string | a server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
| telecom | token | the value in any kind of contact |
| family | string | a portion of the family name |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Practitioner Role
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/PractitionerRole
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/PractitionerRole/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "PractitionerRole",
"id": "{{ResourceId}}",
"meta": {
"lastUpdated": "2022-08-07T03:11:36.000-04:00",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole"
]
},
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"1\"><tbody><span><span><tr><td>Identifier System</td><td><span>urn:oid:2.16.840.1.113883.4.391</span></td></tr><tr><td>Identifier Value</td><td><span>122</span></td></tr></span><span><tr><td>Identifier System</td><td><span>http://hl7.org/fhir/sid/us-npi</span></td></tr><tr><td>Identifier Value</td><td><span>1975662341</span></td></tr></span></span><tr><td>Active</td><td><span>true</span></td></tr><tr><td>Practioner Role Code</td><td><span>223366009</span></td></tr><span><tr><td>Practioner Role</td><td><span>Healthcare professional</span></td></tr></span></tbody></table></div>",
},
"identifier": [
{
"system": "urn:oid:2.16.840.1.113883.4.391",
"value": "122"
},
{
"system": "http://hl7.org/fhir/sid/us-npi",
"value": "1975662341"
}
],
"active": true,
"practitioner": {
"reference": "Practitioner/105",
"type": "Practitioner"
},
"organization": {
"reference": "Organization/{{PayerId}}",
"type": "Organization"
},
"code": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "223366009",
"display": "Healthcare professional"
}
]
{
"text": "Healthcare professional"
},
"specialty": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "309341008",
"display": "Blood transfusion doctor"
}
],
"text": "Blood transfusion doctor"
}
],
"location": [
{
"reference": "Westborough Medical Associates/Hig.kpDnjkh0tsiuhy137v0bzOBSUFSIPWBtFHKdWOI",
"type": "Westborough Medical Associates",
"display": "Westborough Medical Associates"
}
]
}
Procedures (Orders)
Definition : The Organization resource is used to fetch lab organization associated with a patient or practitioner. The resource shall conform to the US Core Organization Profile (v3.1.1: STU3).
Procedures (Orders)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | external Identifiers for this procedure |
| instantiatesCanonical | canonical | 0..* | instantiates FHIR protocol or definition |
| instantiatesUri | uri | 0..* | instantiates external protocol or definition |
| basedOn | Reference | 0..* | a request for this procedure |
| partOf | Reference | 0..* | part of referenced event |
| status | code | 1..1 | preparation |
| statusReason | CodeableConcept | 0..1 | reason for current status |
| category | CodeableConcept | 0..1 | classification of the procedure |
| code | CodeableConcept | 1..1 | identification of the procedure - Binding |
| subject | Reference(US Core Patient Profile) | 1..1 | who the procedure was performed on |
| encounter | Reference | 0..1 | encounter created as part of |
| recorder | Reference | 0..1 | who recorded the procedure |
| asserter | Reference | 0..1 | person who asserts this procedure |
| performedDateTime | dateTime | 1..1 | date/period the procedure was performed - either performedDateTime or performedPeriod must be set |
| performedPeriod | Period | 1..1 | date/period the procedure was performed - either performedDateTime or performedPeriod must be set |
| performer | BackboneElement | 0..* | the people who performed the procedure |
| location | Reference | 0..1 | where the procedure happened |
| reasonCode | CodeableConcept | 0..* | coded reason procedure performed |
| reasonReference | Reference | 0..* | condition that is the reason the procedure performed |
| bodySite | CodeableConcept | 0..* | target body sites |
| outcome | CodeableConcept | 0..1 | the result of procedure |
| report | Reference | 0..* | any report resulting from the procedure |
| complication | CodeableConcept | 0..* | complication following the procedure |
| complicationDetail | Reference | 0..* | a condition that is a result of the procedure |
| followUp | CodeableConcept | 0..* | instructions for follow up |
| note | Annotation | 0..* | additional information about the procedure |
| focalDevice | BackboneElement | 0..* | device changed in procedure |
| usedReference | Reference | 0..* | items used during procedure |
| usedCode | CodeableConcept | 0..* | coded items used during the procedure |
Search Parameters
| Header | ||
|---|---|---|
| Name | Type | Description |
| date | date | date/period the procedure was performed |
| code | token | a code to identify a procedure |
| code_display | string | a code to identify a procedure |
| code:text | string | a code to identify a procedure |
| performer | reference | the reference to the practitioner |
| subject | reference | search by subject |
| encounter | reference | search by encounter |
| patient | reference | search by subject - a patient |
| context | reference | encounter or episode associated with the procedure |
| status | token | preparation |
| _include | undefined | Procedure:performer |
| _revinclude | undefined | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Procedures (Orders)
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Procedure",
"id": {{ResourceId}},
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "399208008",
"display": "Plain chest X-ray (procedure)"
}
],
"text": "Plain chest X-ray (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/273"
},
"performedPeriod": {
"start": "1975-04-07T02:42:45-04:00",
"end": "1975-04-07T03:12:45-04:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
}
Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "bdf37cdc-00e1-447d-963d-3cbffd35fda9",
"meta": {
"lastUpdated": "2022-11-04T16:04:19.437+00:00"
}
"type": "searchset",
"total": 11,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure?date=gt1975-04-06T02%3A42%3A45-04%3A00&patient={{PPG}}"
}
,
{
"relation": "next",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}?_getpages=bdf37cdc-00e1-447d-963d-3cbffd35fda9&_getpagesoffset=10&_count=10&_pretty=true&_bundletype=searchset"
}
]
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure/{{ResourceId}}",
"resource": {
"resourceType": "Procedure",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
}
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "399208008",
"display": "Plain chest X-ray (procedure)"
}
]
"text": "Plain chest X-ray (procedure)",
"subject": {
"reference": "Patient/{{PPG}}"
}
"performedPeriod": {
"start": "2022-01-12T00:00:00Z",
"end": "2022-01-12T00:00:00Z"
}
{
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure/300",
"resource": {
"resourceType": "Procedure",
"id": "300",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "431182000",
"display": "Placing subject in prone position (procedure)"
}
],
"text": "Placing subject in prone position (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/298"
},
"performedPeriod": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-28T02:40:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
},
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Procedure/291",
"resource": {
"resourceType": "Procedure",
"id": "291",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
]
},
"status": "completed",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "431182000",
"display": "Placing subject in prone position (procedure)"
}
],
"text": "Placing subject in prone position (procedure)"
},
"subject": {
"reference": "Patient/{{PPG}}"
},
"encounter": {
"reference": "Encounter/290"
},
"performedPeriod": {
"start": "1977-03-28T02:25:45-05:00",
"end": "1977-03-28T02:40:45-05:00"
},
"location": {
"reference": "Location/103",
"display": "LOWELL GENERAL HOSPITAL"
}
},
"search": {
"mode": "match"
}
}
}
}
Provenance
Definition : The Provenance resource is used to fetch provenance information associated with a resource. The resource shall conform to the US Core Provenance Profile (v3.1.1: STU3).
Provenance
Resource Content
| Name | Type | Cardinality | Required | Description |
|---|---|---|---|---|
| target | Reference | 1..* | * | Target reference(s), usually version specific |
| occurredPeriod | Period | 0..1 | When the activity occurred | |
| occurredDateTime | date | 0..1 | When the activity occurred | |
| recorded | instant | 1..1 | * | When the activity was recorded / updated |
| policy | uri | 0..* | Policy or plan the activity was defined by | |
| location | Reference | 0..1 | Where the activity occurred, if relevant | |
| reason | CodeableConcept | 0..* | Reason the activity is occurring | |
| activity | CodeableConcept | 0..1 | Activity that occurred | |
| agent | BackboneElement | 1..* | * | Actor involved |
| agent.type | CodeableConcept | 0..* | How the agent participated (see Profiles for details) | |
| agent.who | Reference(US Core Practitioner Profile | US Core Patient Profile | US Core Organization Profile) | 1..1 |
| agent.onBehalfOf | Reference | 0..1 | Who the agent is representing (see Profiles for details) | |
| entity | BackboneElement | 0..* | An entity used in this activity | |
| signature | Signature | 0..* | Indicates if the individual is deceased or not |
Organization
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Provenance",
"id": "{{ResourceId}}",
"meta": {
"versionId": "1",
"lastUpdated": "2021-03-23T19:36:17.299+00:00",
"source": "#E1VolYkq84D3M96u",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-provenance"
]
},
"target": [
{
"target": [
{
"reference": "Patient/{{PPG}}"
},
{
"reference": "Location/86"
},
{
"reference": "Organization/87"
},
{
"reference": "Practitioner/88"
},
{
"reference": "PractitionerRole/89"
},
{
"reference": "Encounter/90"
},
{
"reference": "Observation/91"
},
...
],
"recorded": "1977-07-15T01:11:45.131-04:00",
"agent": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/provenance-participant-type",
"code": "author",
"display": "Author"
}
],
"text": "Author"
},
"who": {
"reference": "Practitioner/88",
"display": "Dr. Melvin857 Torp761"
},
"onBehalfOf": {
"reference": "Organization/87",
"display": "PCP87052"
}
},
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/us/core/CodeSystem/us-core-provenance-participant-type",
"code": "transmitter",
"display": "Transmitter"
}
],
"text": "Transmitter"
},
"who": {
"reference": "Patient/{{PPG}}"
"display": "Dr. Melvin857 Torp761"
},
"onBehalfOf": {
"reference": "Organization/87",
"display": "PCP87052"
}
}
]
}
Organization (Pharmacy)
Definition : The Organization resource is used to fetch lab organization associated with a patient or practitioner. The resource shall conform to the US Core Organization Profile (v3.1.1: STU3).
Organization (Pharmacy)
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| id | string | 0..1 | Organization resource entry id. |
| meta | Meta | 0..1 | Metadata(profile) about the resource |
| identifier | (Slice Definition) | 0..* | Identifier associated with this organization across multiple systems |
| active | boolean | 1..1 | Whether the organization's record is still in active use |
| name | string | 1..1 | Name used for the organization |
| telecom | ContactPoint | 0..* | A contact detail for the organization |
| address | Address | 0..* | An address for the organization |
Search Parameters
| Name | Type | Description |
|---|---|---|
| identifier | token | any identifier for the organization (not the accreditation issuer's identifier) |
| partof | reference | an organization of which this organization forms a part |
| address | string | a (part of the) address of the organization |
| address-state | string | a state specified in an address |
| active | token | a server defined search that may match any of the string fields in the Address, including line, city, state, country, postalCode, and/or text |
| type | token | a code for the type of organization |
| address-postalcode | string | a postal code specified in an address |
| name | string | a portion of the organization's name or alias |
| address-city | string | a city specified in an address |
| _revinclude | Provenance:target |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Organization
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Organization/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Organization",
"id": "{{ResourceId}}",
"meta": {
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization"
]
},
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><table border="1"><tbody><tr><td>Name</td><td><span>CVS Westborough</span></td></tr><tr><td>Address</td><td><div class="hapiHeaderText"><span>74 E Main St</span><br/><span>Westborough </span><span>MA </span><span>US </span></div></td></tr><span><tr><td>Telecom Value</td><td><span>508-366-0670</span></td></tr></span></tbody></table></div>"}
},
"identifier": [
{
"system": "urn:oid:2.16.840.1.113883.4.391",
"value": "pharmacy-2"
}
,
{
"system": "http://hl7.org/fhir/sid/us-npi",
"_value": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode": "unknown"
}
]
}
}
],
"active": true,
"name": "CVS Westborough",
"telecom": [
{
"system": "phone",
"value": "508-366-0670"}
]
"address": [
{
"line": [
"74 E Main St"
],
"city": "Westborough",
"state": "MA",
"postalCode": "01581",
"country": "US"
}
]
}
}
}
Specimen
Definition : A sample to be used for analysis.
Specimen
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | External Identifier |
| accessionIdentifier | Identifier | 0..1 | Identifier assigned by the lab |
| status | code | 0..1 | available | unavailable | unsatisfactory | entered-in-error |
| type | CodeableConcept | 0..1 | Kind of material that forms the specimen |
| subject | Reference(Patient | Group | Device | BiologicallyDerivedProduct | Substance | Location) | 0..1 | This may be from patient(s), from a location or a sampling of a substance, a biologically-derived product |
| receivedTime | dateTime | 0..1 | The time when specimen is received by the testing laboratory |
| The time when specimen is received by the testing laboratory | Reference | 0..* | Specimen from which this specimen originated |
| request | Reference | 0..* | Why the specimen was collected |
| combined | code | 0..1 | grouped | pooled |
| role | CodeableConcept | 0..* | The role the specimen serves |
| type | CodeableConcept | 1..1 | Highlighted feature |
| description | string | 1..1 | Information about the feature |
| collector | Reference | 0..1 | Who collected the specimen |
| collectedDateTime | dateTime | 0..1 | Collection time |
| collectedPeriod | Period | 0..1 | Collection time |
| duration | Duration | 0..1 | How long it took to collect specimen |
| quantity | SimpleQuantity | 0..1 | The quantity of specimen collected |
| method | CodeableConcept | 0..1 | Technique used to perform collection |
| device | CodeableReference | 0..1 | Device used to perform collection |
| procedure | Reference | 0..1 | The procedure that collects the specimen |
| bodySite | CodeableReference | 0..1 | Anatomical collection site |
| fastingStatusCodeableConcept | CodeableConcept | 0..1 | Whether or how long patient abstained from food and/or drink |
| fastingStatusDuration | Duration | 0..1 | Whether or how long patient abstained from food and/or drink |
| description | string | 0..1 | Textual description of procedure |
| method | CodeableConcept | 0..1 | Indicates the treatment step applied to the specimen |
| performer | Reference | 0..1 | Entity processing specimen |
| device | Reference | 0..1 | Device used to process the specimen |
| additive | Reference | 0..* | Material used in the processing step |
| timeDateTime | dateTime | 0..1 | Date and time of specimen processing |
| specimenQuantity | SimpleQuantity | 0..1 | Quantity of specimen within container |
Search Parameters
| Name | Type | Description |
|---|---|---|
| accession | token | The accession number associated with the specimen |
| bodysite | reference | Reference to a resource (by instance) |
| collected | date | The date the specimen was collected |
| collector | reference | Who collected the specimen |
| container-device | reference | The unique identifier associated with the specimen container |
| container-location | reference | The location of the specimen container |
| identifier | token | The unique identifier associated with the specimen |
| organization | reference | The organization where the specimen is located |
| parent | reference | The parent of the specimen |
| patient | reference | The patient the specimen comes from |
| procedure | reference | The procedure that collected the specimen |
| status | token | available | unavailable | unsatisfactory | entered-in-error |
| subject | reference | The subject of the specimen |
| type | token | The specimen type |
Errors
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Specimen
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Specimen
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Specimen/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Specimen",
"id": {{ResourceId}},
"meta": {
"versionId": "2",
"lastUpdated": "2024-10-22T07:32:43.368-04:00",
"source": "#MQ1HE3Iv7VneQwZT",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen"
]
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "https://github.com/inferno-framework/us-core-test-kit",
"code": "MB"
}
]
},
"system": "urn:oid:2.16.840.1.113883.3.225",
"value": "1"}
],
"accessionIdentifier": {
"system": "https://github.com/inferno-framework/us-core-test-kit",
"value": "urn:oid:2.16.840.1.113883.3.225"
}
,
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "122575003",
"display": "Urine specimen (specimen)"
}
]
},
"text": "Urine specimen (specimen)",
"subject": {
"reference": "Patient/{{PPG}}"
}
,
"collection": {
"bodySite": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "106004",
"display": "Urine (body structure)"
}
]
},
"collected": {
"dateTime": "2024-10-22T07:32:43.368-04:00",
"duration": "PT1H"
}
}
}
}
Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Specimen?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Specimen",
"id": "{{ResourceId}}",
"meta": {
"versionId": "2",
"lastUpdated": "2024-10-22T07:32:43.368-04:00",
"source": "#MQ1HE3Iv7VneQwZT",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen"
]
}
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "https://github.com/inferno-framework/us-core-test-kit",
"code": "MB"}
]
}
"system": "urn:oid:2.16.840.1.113883.3.225",
"value": "1"}
],
"accessionIdentifier": {
"system": "https://github.com/inferno-framework/us-core-test-kit",
"value": "urn:oid:2.16.840.1.113883.3.225"
}
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "122575003",
"display": "Urine specimen (specimen)"
}
]
"text": "Urine specimen (specimen)"
}
"subject": {
"reference": "Patient/{{PPG}}"
}
"collection": {
"bodySite": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "106004",
"display": "Posterior carpal region"
}
]
"text": "Urine specimen (specimen)"
}
{
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "702244006",
"display": "Sterile urine specimen container"
}
]
"text": "Sterile urine specimen container"
}
}
],
"condition": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0493",
"code": "AUT",
"display": "Autolyzed"
}
]
}
]
Coverage
Definition : Financial instrument which may be used to reimburse or pay for health care products and services. Includes both insurance and self-payment.
Coverage
Resource Content
| Name | Type | Cardinality | Description |
|---|---|---|---|
| identifier | Identifier | 0..* | Business Identifier for the coverage |
| status | code | 1..1 | active | cancelled | draft | entered-in-error |
| type | CodeableConcept | 0..1 | Coverage category such as medical or accident |
| policyHolder | Reference(Patient | RelatedPerson | Organization) | 0..1 | Owner of the policy |
| subscriber | Reference(Patient | RelatedPerson) | 0..1 | Subscriber to the policy |
| subscriberId | string | 0..1 | ID assigned to the subscriber |
| beneficiary | Reference | 1..1 | Plan beneficiary |
| dependent | string | 0..1 | Dependent number |
| relationship | CodeableConcept | 0..1 | Beneficiary relationship to the subscriber |
| period | Period | 0..1 | Coverage start and end dates |
| payor | Reference(Organization | Patient | RelatedPerson) | 1..* | Issuer of the policy |
| type | CodeableConcept | 1..1 | Type of class such as 'group' or 'plan' |
| value | string | 1..1 | Value associated with the type |
| name | string | 0..1 | Human readable description of the type and value |
| order | positiveInt | 0..1 | Relative order of the coverage |
| network | string | 0..1 | Insurer network |
| costToBeneficiary | BackboneElement | 0..* | Patient payments for services/products |
| type | CodeableConcept | 0..1 | Cost category |
| valueQuantity | SimpleQuantity | 1..1 | The amount or percentage due from the beneficiary |
| valueMoney | Money | 1..1 | The amount or percentage due from the beneficiary |
| type | CodeableConcept | 1..1 | Exception category |
| period | Period | 0..1 | The effective period of the exception |
| subrogation | boolean | 0..1 | Reimbursement to insurer |
| contract | Reference | 0..* | Contract details |
Search Parameters
| Name | Type | Description |
|---|---|---|
| beneficiary | reference | Covered party |
| class-type | token | Coverage class (eg. plan, group) |
| class-value | string | Value of the class (eg. Plan number, group number) |
| dependent | string | Dependent number |
| identifier | token | The primary identifier of the insured and the coverage |
| patient | reference | Retrieve coverages for a patient |
| payor | reference | The identity of the insurer or party paying for services |
| policy-holder | reference | Reference to the policyholder |
| status | token | The status of the Coverage |
| subscriber | reference | Reference to the subscriber |
| type | token | The kind of coverage (health plan, auto, Workers Compensation) |
| Code | Description |
|---|---|
| 400 | Invalid parameters |
| 404 | Resource not found |
Specimen
Method: GET
https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Coverage
Examples
Using identifier
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Coverage/{{ResourceId}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Coverage",
"id": {{ResourceId}},
"meta": {
"versionId": "3",
"lastUpdated": "2024-10-10T16:23:29.640-04:00",
"source": "#PFkUws0n9HJB84ea",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage"
]
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB"}
]
},
"system": "urn:oid:2.16.840.1.113883.3.225",
"value": "2098"}
],
"status": "active",
"type": {
"coding": [
{
"system": "https://nahdo.org/sopt_nahdo/hipaa_code",
"code": "C",
"display": "Commercial"}
]
},
"coding": [
{
"system": "https://nahdo.org/sopt",
"code": "3712",
"display": "PPO"}
],
"text": "PPO",
"subscriberId": "4569858789",
"beneficiary": {
"reference": "Patient/{{PatientId}}"
},
"relationship": {
"coding": [
{
"system": "http://hl7.org/fhir/v3/RoleCode",
"code": "self"
}
]
},
"payor": [
{
"reference": "Organization/{{PayerId}}"
}
],
"period": {
"start": "2024-10-10T16:23:29.640-04:00",
"end": "2025-10-10T16:23:29.640-04:00"},
"group": {
"name": "Group A",
"type": "group"
},
"insurancePlan": [
{
"reference": "InsurancePlan/{{PlanId}}"
}
],
"order": "1"
}
Using search parameters
Request
GET https://fhir.glaceemr.com/fhir_base_r4/fhir/{accountId}/Coverage?patient={{PPG}}
Response
200 - OK
Headers
| Param | Value | Description | Type |
|---|---|---|---|
| Content-Type | application/json | text |
Body
{
"resourceType": "Bundle",
"id": "726b5a36-de3c-46b4-ba11-63b7bd2e296a",
"meta": {
"lastUpdated": "2024-10-30T01:34:40.530-04:00"
},
"type": "searchset",
"total": 1,
"link": [
{
"relation": "self",
"url": "https://fhir.glaceemr.com/fhir_base_r4/fhir/inferno/Coverage?patient=86453"
}
],
"entry": [
{
"fullUrl": "https://fhir.glaceemr.com/fhir_base_r4/fhir/inferno/Coverage/{{ResourceId}}",
"resource": {
"resourceType": "Coverage",
"id": "{{ResourceId}}",
"meta": {
"versionId": "3",
"lastUpdated": "2024-10-10T16:23:29.640-04:00",
"source": "#PFkUws0n9HJB84ea",
"profile": [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-coverage"
]
},
"identifier": [
{
"use": "usual",
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v2-0203",
"code": "MB"
}
]
},
"system": "urn:oid:2.16.840.1.113883.3.225",
"value": "2098"
}
],
"status": "active",
"type": {
"coding": [
{
"system": "https://nahdo.org/sopt_nahdo/hipaa_code",
"code": "C",
"display": "Commercial"
}
]
},
"coding": [
{
"system": "https://nahdo.org/sopt",
"code": "3712",
"display": "PPO"
}
],
"text": "PPO",
"subscriberId": "4569858789",
"beneficiary": {
"reference": "Patient/{{PPG}}"
},
"relationship": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/subscriber-relationship",
"code": "self"
}
],
"text": "Self"
},
"period": {
"start": "2020-01-01"
},
"payor": [
{
"reference": "Organization/86456"
}
],
"class": [
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "group",
"display": "Group"
}
],
"text": "An employee group"
},
"value": "xyz",
"name": "XYZ employee Group Plan"
},
{
"type": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/coverage-class",
"code": "plan",
"display": "Plan"
}
],
"text": "A specific suite of benefits."
},
"value": "gold",
"name": "Acme Gold Plan"
}
]
},
"search": {
"mode": "match"
}
}
]
}