GET Patient Registries by Id
Developer ToolsGET api/v1/{EMRSystem}/PatientRegistries/{RegistryId}
Returns all of the patients currently on the given patient registry.
HTTP Method
Applicable Emissary Products
Allscripts
Athena
Cerner
Meditech
Sandbox
Don't see the data field you are looking for?
Request Information
URI Parameters
NAME |
DESCRIPTION |
TYPE |
ADDITIONAL INFO |
---|---|---|---|
EMRSystem |
The emr system. |
Required |
|
RegistryId |
The the patient registry identifier. |
string |
Required |
UserId |
Identifier of the user requesting the patient registry. |
string |
None |
Body Parameters
Response Information
Resource Description
NAME |
DESCRIPTION |
TYPE |
ADDITIONAL INFO |
---|---|---|---|
Status |
The patient's current membership status on the registry |
None. |
|
PatientAddedDateTime |
The date/time the patient was added to the registry |
date |
None. |
LastUpdateDateTime |
The last time the patient's membership in the registry was updated |
date |
None. |
Patient |
The Patient |
None. |
Response Codes
Http Status Code 200 – Returns a collection of Sansoro.Shared.SansoroServiceBus.Models.PatientRegistryResponseViewModel
Http Status Code 400 – Indicates that the request did not contain all the required fields.
Http Status Code 404 – Indicates that the resource to get could not be found.
Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
- application/json, text/json
- application/xml, text/xml
Sample Message
Download Json Schema[
{
"PatientAddedDateTime": "2018-02-14T20:39:35.6332063Z",
"LastUpdateDateTime": "2018-02-14T20:39:35.6332063Z",
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "sample string 7",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
},
{
"PatientAddedDateTime": "2018-02-14T20:39:35.6332063Z",
"LastUpdateDateTime": "2018-02-14T20:39:35.6332063Z",
"Patient": {
"PatientId": "sample string 1",
"DisplayName": "sample string 2",
"LastName": "sample string 3",
"FirstName": "sample string 4",
"MiddleName": "sample string 5",
"MRN": "sample string 6",
"BirthDateTime": "sample string 7",
"Gender": {
"Id": "sample string 1",
"Name": "sample string 2"
}
}
}
]
Sample Message
<ArrayOfPatientRegistryResponseViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
<PatientRegistryResponseViewModel>
<LastUpdateDateTime>2018-02-14T14:39:35.6332063-06:00</LastUpdateDateTime>
<Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
<d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
<d3p1:DisplayName>sample string 2</d3p1:DisplayName>
<d3p1:FirstName>sample string 4</d3p1:FirstName>
<d3p1:Gender>
<d3p1:Id>sample string 1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:Gender>
<d3p1:LastName>sample string 3</d3p1:LastName>
<d3p1:MRN>sample string 6</d3p1:MRN>
<d3p1:MiddleName>sample string 5</d3p1:MiddleName>
<d3p1:PatientId>sample string 1</d3p1:PatientId>
</Patient>
<PatientAddedDateTime>2018-02-14T14:39:35.6332063-06:00</PatientAddedDateTime>
</PatientRegistryResponseViewModel>
<PatientRegistryResponseViewModel>
<LastUpdateDateTime>2018-02-14T14:39:35.6332063-06:00</LastUpdateDateTime>
<Patient xmlns:d3p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
<d3p1:BirthDateTime>sample string 7</d3p1:BirthDateTime>
<d3p1:DisplayName>sample string 2</d3p1:DisplayName>
<d3p1:FirstName>sample string 4</d3p1:FirstName>
<d3p1:Gender>
<d3p1:Id>sample string 1</d3p1:Id>
<d3p1:Name>sample string 2</d3p1:Name>
</d3p1:Gender>
<d3p1:LastName>sample string 3</d3p1:LastName>
<d3p1:MRN>sample string 6</d3p1:MRN>
<d3p1:MiddleName>sample string 5</d3p1:MiddleName>
<d3p1:PatientId>sample string 1</d3p1:PatientId>
</Patient>
<PatientAddedDateTime>2018-02-14T14:39:35.6332063-06:00</PatientAddedDateTime>
</PatientRegistryResponseViewModel>
</ArrayOfPatientRegistryResponseViewModel>
Submit a Comment
Your email address will not be published. Required fields are marked *