Patient Information Release Authorization
The Patient Information Release Authorization feature allows the user to create, update, delete, and view the audit history of release authorizations and consents.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Add patient's release authorizations and consent details
POST
/v1/{practiceid}/patients/{patientid}/authorizations
Add a record of release authorization to a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
releaseauthorizationid
integer
The id of the release authorizaton
Example Code
Get patient's release authorizations and consent details
GET
/v1/{practiceid}/patients/{patientid}/authorizations
Retrieve the list of release authorizations for a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
patientid
integer
patientid
showdeleted
boolean
Show deleted authorizations
status
string
Release authorization status (VALID, EXPIRED, REVOKED)
departmentid
integer
Department ID of the patient
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
clientformid
integer
The ID of the client form being authorized for release
clientformname
string
The name of the form that is authorized for release
deleted
string
The date the release authorization was deleted
effectivedate
string
Date that the release authorization is effective from
expirationdate
string
Date that the release authorization expires
note
string
Note in regards to the release authorization
releaseauthorizationid
integer
The id of the release authorizaton
revokeddate
string
Date that the release authorization was revoked
signeddate
string
Date that the patient signed the release authorization
status
string
Current status of the release authorization. These values can be: EXPIRED, VALID, or REVOKED
Example Code
Get specific release authorization record
GET
/v1/{practiceid}/patients/{patientid}/authorizations/{releaseauthorizationid}
Retrieve information of a specific release authorizations for a patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
releaseauthorizationid
integer
releaseauthorizationid
patientid
integer
patientid
showdeleted
boolean
Show deleted authorizations
status
string
Release authorization status (VALID, EXPIRED, REVOKED)
departmentid
integer
Department ID of the patient
Output Parameters
Expand all
clientformid
integer
The ID of the client form being authorized for release
clientformname
string
The name of the form that is authorized for release
deleted
string
The date the release authorization was deleted
effectivedate
string
Date that the release authorization is effective from
expirationdate
string
Date that the release authorization expires
note
string
Note in regards to the release authorization
releaseauthorizationid
integer
The id of the release authorizaton
revokeddate
string
Date that the release authorization was revoked
signeddate
string
Date that the patient signed the release authorization
status
string
Current status of the release authorization. These values can be: EXPIRED, VALID, or REVOKED
Example Code
Update specific release authorization record
PUT
/v1/{practiceid}/patients/{patientid}/authorizations/{releaseauthorizationid}
Modifies information of a specific release authorizations for a patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
releaseauthorizationid
integer
releaseauthorizationid
patientid
integer
patientid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
success
string
Indicates that this call was successful.
Example Code
Delete specific release authorization record
DELETE
/v1/{practiceid}/patients/{patientid}/authorizations/{releaseauthorizationid}
Delete a release authorizations for a specific patient
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
releaseauthorizationid
integer
releaseauthorizationid
patientid
integer
patientid
departmentid
integer
Department ID of the patient
Output Parameters
Expand all
success
string
Indicates that this call was successful.
Example Code