Appearance
Endpoint: /Patient/SendAll
This endpoint will facilitate what is commonly known as a "true-up", where all of a group's patient data can be pulled by the consumer so they can sync up. A maximum of 25 patients can be returned at once. If there are more than 25 results available, subsequent calls with an incrementing page number would be required.
Request: JSON
{
"PageNumber": int
}| Field | Data Type | Required | Comments |
|---|---|---|---|
| PageNumber | Integer | Required | Specifies which page of data (25 results per) the data request is for. |
Response: JSON
{
"Metadata": {
"ApiSender": string,
"ApiConsumer": string,
"MessageDateTime": DateTime
},
"Data": {
"Success": bool,
"PageNumber": int,
"MaxPages": int,
"Patients": [
{
"PatientID": int,
"PatientExternalID": string,
"PatientSecondaryExternalID": string,
"PatientEventID": int,
"PatientStatus": string,
"PatientFirst": string,
"PatientMiddle": string,
"PatientLast": string,
"PatientDOB": DateTime,
"DeceasedDate": DateTime,
"PatientSSN": string,
"PatientGender": string,
"PatientEthnicity": [
{
"EthnicityName": string,
"HL7Code": string,
"UniqueIdentifier": string,
"HierarchicalCode": string
}
],
"PatientRace": [
{
"RaceName": string,
"HL7RaceCode": string,
"HierarchicalCode": string
}
],
"PatientAddress": {
"AddressLine1": string,
"AddressLine2": string,
"City": string,
"State": string,
"Zip": string
},
"PatientPhone": string,
"PatientMobilePhone": string,
"PatientFloor": string,
"PatientRoom": string,
"Facility": {
"FacilityName": string,
"PlaceOfServiceCode": int,
"NPI": string,
"ExternalID": string,
"FacilityAddress": {
"AddressLine1": string,
"AddressLine2": string,
"City": string,
"State": string,
"Zip": string
}
},
"ProblemList": [
{
"ICD10": string,
"SNOMED": long,
"Status": int,
"StatusText": string
}
],
"Insurance": [
{
"InsuranceSetID": int,
"InsuranceCode": string,
"CompanyName": string,
"CompanyAddress": {
"AddressLine1": string,
"AddressLine2": string,
"City": string,
"State": string,
"Zip": string
},
"CompanyContact": string,
"CompanyContactPhone": string,
"GroupNumber": string,
"GroupName": string,
"GroupEmployerID": string,
"PlanEffectiveDate": DateTime,
"PlanExpirationDate": DateTime,
"InsuranceType": string,
"SubscriberFirst": string,
"SubscriberLast": string,
"SubscriberGender": string,
"SubscriberRelationToPatient": string,
"SubscriberAddress": {
"AddressLine1": string,
"AddressLine2": string,
"City": string,
"State": string,
"Zip": string
},
"AssignmentOfBenefits": DateTime,
"InsurancePriority": string,
"PolicyNumber": string,
"SubscriberEmployerAddress": {
"AddressLine1": string,
"AddressLine2": string,
"City": string,
"State": string,
"Zip": string
}
}
],
"PatientLanguage": {
"LanguageName": string,
"Code_639_1": string,
"Code_639_2": string
},
"IsACO": bool
}
]
}
}