Interface Consent

The Interface Consent feature allows the user to view patient's consent to share health data.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Get patient's interface consents

GET
/v1/{practiceid}/patients/{patientid}/interfaceconsents
Retrieves patient's consent to share health data
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
departmentid integer Department ID
limit integer Number of entries to return (default 100, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
consentby string The party deciding to give consent or not. This will either be PATIENT or PARENTGUARDIAN.
consentdate string The date the consent decision was made
consentquestion string The description text for the consent.
consentsetting string The name of the setting for the interface vendor
consentvalue string The explicit value of the consent. This will be Y or N
interfacevendorid string The interface vendor ID
isconsenting string This value will be 1 if the patient gives consent to the vendor. It is possible that the patient/gaurdian has not actively given consent, in which case this value is determined by whether the vendor is opt-in or opt-out.
Example Code

Update patient's interface consents

PUT
/v1/{practiceid}/patients/{patientid}/interfaceconsents
Modifies the existing patient's consent to share health data
Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
patientid integer patientid
Content-Type string Content type of the payload

❙ Request Body

Expand all
consents array A JSON array of consents to be updated.
departmentid integer Department ID

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Returns true/false if the operation was successful
Example Code