Chirp Patient Api Documentation

The following are a series of apis that satisfy CEHRT Regulations § 170.315(g)(7) and § 170.315(g)(9) for Chirp version 1.1. Documentation of the apis that satisfy CEHRT Regulations § 170.315(g)(10) can be found at https://apidocs.onemedical.io/fhir/overview/

Registration

SMART on FHIR applications need to be registered with Chirp before they can be used. To start the registration process, please submit a request by filling out this form.. Chirp will review your request and if you are approved you will receive an OAuth client_id to use on subsequent requests following the protocols specified in the official SMART App Authorization Guide.

After registering an account, credentials will be given which will enable you to generate an Authorization Grant and Access Token.

Authentication

Chirp APIs are authenticated using the OAuth 2.0 protocol. All API requests must include an Authorization header with an Access Token of the form:

Authorization: Bearer MY_ACCESS_TOKEN

Public applications, such as native apps, which are incapable of securely storing credentials will not be issued a client_secret. Instead, the authorization_code grant flow will be used to issue refresh tokens. As recommended in the OAuth 2.0 Authorization Framework spec (RFC 6749), we require additional security measures when issuing refresh tokens to native applications. Specifically, we enforce refresh token rotation for all public applications, which is an auth flow in which each refresh token issued is valid for one use only. Whenever a public application uses a refresh token to request an access token, a new refresh token will be returned in the response body in addition to the requested access token. See Auth0’s “Refresh Token Rotation” documentation for additional details.

Errors

Chirp Apis use the HTTP status codes below to report the status of the request and the type of error you may have encountered.

  • 200 - OK
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not found
  • 422 - Unprocessable Entity
  • 500 - Internal Server Error
GET Patient Selection
https://production.icisapp.com/api/v1/fhir/Patient.json?name=thund&birthdate=1961-07-07

Get the unique identifier of a patient record. This is a FHIR api.

PARAMS

name
thund

[OPTIONAL] Part of the given or family name of the patient

family
None

[OPTIONAL] Part of the family name of the patient

identifier
None

[OPTIONAL] A patient identifier

birthdate
1961-07-07

[OPTIONAL] The patient's date of birth (format: YYY_MM_DD)

gender
None

[OPTIONAL] Gender of the patient (male|female|other|unknown)

Example Request
                                    
GET production.icisapp.com/api/v1/fhir/Patient.json?name=thund&birthdate=1961-07-07
                                
Example Response
200 - OK
GET Patient Demographics
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=patient
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
patient

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                    
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=patient
                                
Example Response
200 - OK
GET Smoking Status
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=social_history
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
social_history

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=social_history
                                  
Example Response
200 - OK
GET Problems
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=problem
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
problem

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=problem
                                  
Example Response
200 - OK
GET Medications
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=medication
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
medication

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=medication
                                  
Example Response
200 - OK
GET Allergies
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=allergy
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
allergy

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=allergy
                                  
Example Response
200 - OK
GET Lab Results
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=result
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
result

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=result
                                  
Example Response
200 - OK
GET Vital Signs
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=vital
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
vital

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=vital
                                  
Example Response
200 - OK
GET Procedures
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=procedures
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
procedures

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=procedures
                                  
Example Response
200 - OK
GET Immunizations
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=immunization
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
immunization

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=immunization
                                  
Example Response
200 - OK
GET Medical Equipment
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=medical equipment
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
medical equipment

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=medical equipment
                                  
Example Response
200 - OK
GET Assessment
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=assessment
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
assessment

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=assessment
                                  
Example Response
200 - OK
GET Plan of Treatment
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=plan_of_treatment
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
plan_of_treatment

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=plan_of_treatment
                                  
Example Response
200 - OK
GET Goals
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=goal
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
goal

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=goal
                                  
Example Response
200 - OK
GET Health Concerns
https://production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=health_concern
PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

section
health_concern

[REQUIRED] The name of the section

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccd_sections?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&section=health_concern
                                  
Example Response
200 - OK
GET Care Team Members
https://production.icisapp.com/api/v1/fhir/CareTeam.json?patient=1209bf4f506f4bb08b87a11b9f86d063&status=active

This is a FHIR endpoint

PARAMS

patient
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

status
active

[REQUIRED] The status of the care team

Example Request
                                      
GET production.icisapp.com/api/v1/fhir/CareTeam.json?patient=1209bf4f506f4bb08b87a11b9f86d063&status=active
                                  
Example Response
200 - OK
GET Full CCDA
https://production.icisapp.com/api/xml/ccds?patient_guid=1209bf4f506f4bb08b87a11b9f86d063

Generate a Full CCD for a patient given a guid

PARAMS

patient_guid
1209bf4f506f4bb08b87a11b9f86d063

[REQUIRED] The ID of the patient

start_date
1990-01-01

[OPTIONAL] The beginning of the date range of the requested data

end_date
2021-07-02

[OPTIONAL] The end of the date range of the requested data

Example Request
                                      
GET production.icisapp.com/api/xml/ccds?patient_guid=1209bf4f506f4bb08b87a11b9f86d063&start_date=1990-01-01&end_date=2021-07-02
                                  
Example Response
200 - OK
Disclosures
Real World Test Plans
Terms Of Use