TechCare 5.0 API
  • Home
  • Docs
  • Terms
  • RWTP
  • EHI Export

Documentation

About this API

The TechCare API follows REST standards. To make use of this API, your application should be capable of making HTTP requests and should accept responses in JSON format.

IMPORTANT: Local customer security policies must be in place to prevent unauthorized monitoring or eavesdropping on connections to and from this API.

For more information about the REST style, click here.

Getting access

To request access, please send an email to helpdesk@naphcare.com with "API Access" in the subject line.

Authorization

To make requests, you must first acquire a JWT token for authorization. To do this, make a POST request to api2.naphcare.com/api/Account/Login with the following parameters:

Username
Your TechCare username. Note: If you do not have a TechCare account, see the Getting access section.
Password
Your TechCare password

If your login is successful, you will receive an authentication token in the body of the response. You will need to provide this token in subsequent requests by adding the following HTTP request header:

Authorization: Bearer <your token here>

Making requests

To make requests to this API, use api2.naphcare.com, followed by one of the routes listed in the API Endpoints section.

For example, to retrieve a CDA for an inmate with InmateID "123", your would make a GET request to api2.naphcare.com/api/CCDA/123

Make sure to include your authentication token. See the Authorization section for details on getting and using a token.

Errors

Requests that can't be completed will result in a response with one of the following HTTP error codes:

400
Bad Request. Something about your request is invalid. Make sure that all required parameters are provided and in the correct format.
401
Unauthorized. Your request failed authorization. Make sure you are providing your access token as described in the Authorization section.
403
Forbidden. Your user was found and is authenticated successfully, but you do not have the permissions required to access the requested endpoint. For help with this, email helpdesk@naphcare.com.
404
Not Found. The resource you are trying to access can not be found. This may be due to an incorrect ID being used, or it may indicate that you are trying to access an API endpoint that does not exist.

API Endpoints

Account

APIDescription
POST api/Account/Login

Attempts to authenticate the username and password

Inmate

APIDescription
GET api/Inmate

Gets the list of all inmates

GET api/Inmate/{id}

Gets an inmate by InmateID

CCDA

API endpoints related to Inmate C-CDAs

APIDescription
GET api/CCDA/{id}?startDate={startDate}&endDate={endDate}

Gets the CDA for an inmate given the InmateID

GET api/CCDA/{id}/Digest?startDate={startDate}&endDate={endDate}

Retrieves a sha256 checksum for the CDA for the specified patient

GET api/CCDA/{id}/Demographics

Gets the demographics portion of the CDA

GET api/CCDA/{id}/Problems?startDate={startDate}&endDate={endDate}

Gets the problems portion of the CDA

GET api/CCDA/{id}/Medications?startDate={startDate}&endDate={endDate}

Gets the medications portion of the CDA

GET api/CCDA/{id}/DrugAllergy

Gets the drug allergies portion of the CDA

GET api/CCDA/{id}/LaboratoryTest?startDate={startDate}&endDate={endDate}

Gets the laboratory tests portion of the CDA

GET api/CCDA/{id}/LaboratoryResult?startDate={startDate}&endDate={endDate}

Gets the lab test result portion of the CDA

GET api/CCDA/{id}/VitalSigns?startDate={startDate}&endDate={endDate}

Gets the vital signs portion of the CDA

GET api/CCDA/{id}/Procedure?startDate={startDate}&endDate={endDate}

Gets the procedures portion of the CDA

GET api/CCDA/{id}/CareTeam

Gets the care team portion of the CDA

GET api/CCDA/{id}/Immunization

Gets the immunizations portion of the CDA

GET api/CCDA/{id}/ImplantableDevice

Gets the implantable device portion of the CDA

GET api/CCDA/{id}/TreatmentPlan?startDate={startDate}&endDate={endDate}

Gets the treatment plan portion of the CDA

GET api/CCDA/{id}/Goal?startDate={startDate}&endDate={endDate}

Gets the goals portion of the CDA

GET api/CCDA/{id}/HealthConcern?startDate={startDate}&endDate={endDate}

Gets the health concerns portion of the CDA