POST api/AllData/Get

Request Information

URI Parameters

None.

Body Parameters

BaseRequest
NameDescriptionTypeAdditional information
PersonUid

Encryped passcode for the authenticated user.

string

Required

StartDate

Start date of the request. A time component is not used when passing the start date.

date

[Optional]

EndDate

End date of the request. A time component is not used when passing the end date.

date

[Optional]

Request Formats

application/json, text/json

Sample:
{
  "PersonUid": "sample string 1",
  "StartDate": "2019-08-19T16:16:29.4526182-04:00",
  "EndDate": "2019-08-19T16:16:29.4526182-04:00"
}

Response Information

Resource Description

AllDataResponse
NameDescriptionTypeAdditional information
PatientName

PatientNameResponse
DateOfBirth

DateOfBirthResponse
Sex

SexResponse
Language

LanguageResponse
Ethnicity

EthnicityResponse
DetailedEthnicity

DetailedEthnicityResponse
Race

RaceResponse
DetailedRace

DetailedRaceResponse
Assessment

AssessmentResponse
CareTeamMember

CareTeamMemberResponse
Goal

GoalResponse
HealthConcern

HealthConcernResponse
Immunization

ImmunizationResponse
LabResult

LabResultResponse
LabTest

LabTestResponse
MedicationAllergy

MedicationAllergyResponse
Medication

MedicationResponse
Problem

ProblemResponse
Procedure

ProcedureResponse
SmokingStatus

SmokingStatusResponse
TreatmentPlan

TreatmentPlanResponse
UDI

UDIResponse
VitalSigns

VitalSignsResponse
ErrorMessage

If the success property is false, the ErrorMessage property will contain error text, otherwise it will be null.

string
ErrorType

Text of the type of error that has occured (See the Error Handling section for more information).

string
Success

Represents the success of the call.

boolean

Response Formats

application/json, text/json

Sample:
{
  "PatientName": {
    "FirstName": "sample string 1",
    "MiddleName": "sample string 2",
    "LastName": "sample string 3",
    "PreviousLastName": "sample string 4",
    "PreviousFirstName": "sample string 5",
    "Suffix": "sample string 6",
    "ErrorMessage": "sample string 7",
    "ErrorType": "sample string 8",
    "Success": true
  },
  "DateOfBirth": {
    "DateOfBirth": "sample string 1",
    "ErrorMessage": "sample string 2",
    "ErrorType": "sample string 3",
    "Success": true
  },
  "Sex": {
    "Sex": "sample string 1",
    "ErrorMessage": "sample string 2",
    "ErrorType": "sample string 3",
    "Success": true
  },
  "Language": {
    "Name": "sample string 1",
    "Iso6392Code": "sample string 2",
    "ErrorMessage": "sample string 3",
    "ErrorType": "sample string 4",
    "Success": true
  },
  "Ethnicity": {
    "Ethnicities": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      }
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "DetailedEthnicity": {
    "Ethnicities": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      }
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Race": {
    "Races": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      }
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "DetailedRace": {
    "Races": [
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      },
      {
        "Name": "sample string 1",
        "Code": "sample string 2"
      }
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Assessment": {
    "Assessment": [
      "sample string 1",
      "sample string 2"
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "CareTeamMember": {
    "CareTeamMembers": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "MiddleName": "sample string 3",
        "Suffix": "sample string 4",
        "PostFix": "sample string 5",
        "PerformerFunctionCode": "sample string 6"
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "MiddleName": "sample string 3",
        "Suffix": "sample string 4",
        "PostFix": "sample string 5",
        "PerformerFunctionCode": "sample string 6"
      }
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Goal": {
    "Goals": [
      "sample string 1",
      "sample string 2"
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "HealthConcern": {
    "HealthConcern": [
      "sample string 1",
      "sample string 2"
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Immunization": {
    "Immunizations": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "LabResult": {
    "LabPanels": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "LabTest": {
    "LabTests": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "MedicationAllergy": {
    "MedicationAllergies": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Medication": {
    "Medications": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Problem": {
    "Problems": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "Procedure": {
    "Procedures": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "SmokingStatus": {
    "SmokingStatuses": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "TreatmentPlan": {
    "TreatmentPlan": [
      "sample string 1",
      "sample string 2"
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "UDI": {
    "UniqueDeviceIdentifier": null,
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "VitalSigns": {
    "VitalSigns": [
      {
        "Code": "sample string 1",
        "CodeSystem": "sample string 2",
        "VitalsName": "sample string 3",
        "Date": "sample string 4",
        "Value": "sample string 5",
        "Units": "sample string 6"
      },
      {
        "Code": "sample string 1",
        "CodeSystem": "sample string 2",
        "VitalsName": "sample string 3",
        "Date": "sample string 4",
        "Value": "sample string 5",
        "Units": "sample string 6"
      }
    ],
    "ErrorMessage": "sample string 1",
    "ErrorType": "sample string 2",
    "Success": true
  },
  "ErrorMessage": "sample string 1",
  "ErrorType": "sample string 2",
  "Success": true
}