Sign in

v1

latestSwagger 2.02026-08-061791731.4 MB
Patient Demographics

{{baseUrl}}/persons/:personId

Gets the demographics for the specified person id.

get/persons/{personId}

Path parameters

personIdstring required

(Required) (Required) The id of the person whose demographics are being retrieved

Headers

Acceptstring required

Response

OK

idstring required
firstNamestring required
lastNamestring required
middleNamestring required
prefixstring required
prefixIdstring required
suffixstring required
suffixIdstring required
addressLine1string required
addressLine2string required
citystring required
statestring required
zipstring required
countryIdstring required
countrystring required
countyIdstring required
countystring required
secondaryAddressLine1string required
secondaryAddressLine2string required
secondaryCitystring required
secondaryStatestring required
secondaryZipstring required
secondaryCountryIdstring required
secondaryCountrystring required
secondaryCountyIdstring required
secondaryCountystring required
homePhonestring required
homePhoneCommentstring required
secondaryHomePhonestring required
secondaryHomePhoneCommentstring required
dayPhonestring required
dayPhoneExtensionstring required
dayPhoneCommentstring required
alternatePhonestring required
alternatePhoneDescriptionstring required
alternatePhoneExtensionstring required
alternatePhoneCommentstring required
internationalHomePhonestring required
internationalWorkPhonestring required
internationalZipstring required
cellPhonestring required
cellPhoneCommentstring required
emailstring required
emailAddressCommentstring required
contactSequencestring required
sexstring required
dateOfBirthstring required
agestring required
socialSecurityNumberstring required
contactPreferenceIdstring required
contactPreferenceDescriptionstring required
primaryCareProviderIdstring required
primaryCareProviderFullNamestring required
primaryCareProviderFirstNamestring required
primaryCareProviderLastNamestring required
primaryCareProviderMiddleInitialstring required
maritalStatusstring required
studentStatusstring required
isExpiredstring required
isSmokerstring required
isVeteranstring required
notificationPreferenceSelectedstring required
preferredLanguageIdstring required
preferredLanguagestring required
religionIdstring required
churchIdstring required
udsHomelessStatusIdstring required
udsMigrantWorkerStatusIdstring required
udsLanguageBarrierIdstring required
udsPrimaryMedicalCoverageIdstring required
udsPublicHousingPrimaryCareIdstring required
udsSchoolBasedHealthCenterIdstring required
udsTribalAffiliationIdstring required
udsBloodQuantumIdstring required
udsVeteranStatusstring required
isSelfPayerstring required
udsHasConsentToTreatstring required
udsConsentToTreatDatestring required
udsIhsEligibilityStatusIdstring required
udsTribalClassIdstring required
udsDecendancyIdstring required
communityCodeIdstring required
currentGenderstring required
previousFirstNamestring required
sexualOrientationstring required
preferredPronounstring required
patientStatusIdstring required
patientStatusChangeReasonIdstring required
userDefinedDemographic1Idstring required
userDefinedDemographic2Idstring required
userDefinedDemographic3Idstring required
userDefinedDemographic4Idstring required
userDefinedDemographic5Idstring required
userDefinedDemographic6Idstring required
userDefinedDemographic7Idstring required
userDefinedDemographic8Idstring required
userDefinedDemographic9Idstring required
userDefinedDemographic10Idstring required
userDefinedDemographic11Idstring required
userDefinedDemographic12Idstring required
userDefinedDemographic13Idstring required
userDefinedDemographic14Idstring required
isCurrentGenderProtectedstring required
isGenderIdentityProtectedstring required
isPreferredPronounProtectedstring required
isSexualOrientationProtectedstring required
otherIdNumberstring required
priorLastNamestring required
externalIdstring required
primaryDentalProviderIdstring required
primaryDentalProviderNamestring required
nicknamestring required
showContactInfoOnAlertstring required
mothersMaidenNamestring required
hasEmailstring required
hasPhoneNumberstring required
usesPortalstring required
usesSmsstring required
hasVoicestring required
isOptOutstring required
isHomePhoneNotApplicablestring required
isCellPhoneNotApplicablestring required
isAlternatePhoneNotApplicablestring required
isDayPhoneNotApplicablestring required
isSecondaryHomePhoneNotApplicablestring required
isInternationalPhoneNotApplicablestring required
isEmailNotApplicablestring required
expiredDatestring required
expiredTimestring required
expiredTimeTzstring required
birthMothersLastNamestring required
birthMothersFirstNamestring required
birthMothersMiddleNamestring required
exemptFromPersonMergestring required
addressTypeIdstring required
secondaryAddressTypeIdstring required
isEnterpriseChartstring required
otherReasonSexualOrientationstring required

Example response

{
  "id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "middleName": "<string>",
  "prefix": "<string>",
  "prefixId": "<string>",
  "suffix": "<string>",
  "suffixId": "<string>",
  "addressLine1": "<string>",
  "addressLine2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "countryId": "<string>",
  "country": "<string>",
  "countyId": "<string>",
  "county": "<string>",
  "secondaryAddressLine1": "<string>",
  "secondaryAddressLine2": "<string>",
  "secondaryCity": "<string>",
  "secondaryState": "<string>",
  "secondaryZip": "<string>",
  "secondaryCountryId": "<string>",
  "secondaryCountry": "<string>",
  "secondaryCountyId": "<string>",
  "secondaryCounty": "<string>",
  "homePhone": "<string>",
  "homePhoneComment": "<string>",
  "secondaryHomePhone": "<string>",
  "secondaryHomePhoneComment": "<string>",
  "dayPhone": "<string>",
  "dayPhoneExtension": "<string>",
  "dayPhoneComment": "<string>",
  "alternatePhone": "<string>",
  "alternatePhoneDescription": "<string>",
  "alternatePhoneExtension": "<string>",
  "alternatePhoneComment": "<string>",
  "internationalHomePhone": "<string>",
  "internationalWorkPhone": "<string>",
  "internationalZip": "<string>",
  "cellPhone": "<string>",
  "cellPhoneComment": "<string>",
  "email": "<string>",
  "emailAddressComment": "<string>",
  "contactSequence": "<string>",
  "sex": "<string>",
  "dateOfBirth": "<string>",
  "age": "<string>",
  "socialSecurityNumber": "<string>",
  "contactPreferenceId": "<string>",
  "contactPreferenceDescription": "<string>",
  "primaryCareProviderId": "<string>",
  "primaryCareProviderFullName": "<string>",
  "primaryCareProviderFirstName": "<string>",
  "primaryCareProviderLastName": "<string>",
  "primaryCareProviderMiddleInitial": "<string>",
  "maritalStatus": "<string>",
  "studentStatus": "<string>",
  "isExpired": "<string>",
  "isSmoker": "<string>",
  "isVeteran": "<string>",
  "notificationPreferenceSelected": "<string>",
  "preferredLanguageId": "<string>",
  "preferredLanguage": "<string>",
  "religionId": "<string>",
  "churchId": "<string>",
  "udsHomelessStatusId": "<string>",
  "udsMigrantWorkerStatusId": "<string>",
  "udsLanguageBarrierId": "<string>",
  "udsPrimaryMedicalCoverageId": "<string>",
  "udsPublicHousingPrimaryCareId": "<string>",
  "udsSchoolBasedHealthCenterId": "<string>",
  "udsTribalAffiliationId": "<string>",
  "udsBloodQuantumId": "<string>",
  "udsVeteranStatus": "<string>",
  "isSelfPayer": "<string>",
  "udsHasConsentToTreat": "<string>",
  "udsConsentToTreatDate": "<string>",
  "udsIhsEligibilityStatusId": "<string>",
  "udsTribalClassId": "<string>",
  "udsDecendancyId": "<string>",
  "communityCodeId": "<string>",
  "currentGender": "<string>",
  "previousFirstName": "<string>",
  "sexualOrientation": "<string>",
  "preferredPronoun": "<string>",
  "patientStatusId": "<string>",
  "patientStatusChangeReasonId": "<string>",
  "userDefinedDemographic1Id": "<string>",
  "userDefinedDemographic2Id": "<string>",
  "userDefinedDemographic3Id": "<string>",
  "userDefinedDemographic4Id": "<string>",
  "userDefinedDemographic5Id": "<string>",
  "userDefinedDemographic6Id": "<string>",
  "userDefinedDemographic7Id": "<string>",
  "userDefinedDemographic8Id": "<string>",
  "userDefinedDemographic9Id": "<string>",
  "userDefinedDemographic10Id": "<string>",
  "userDefinedDemographic11Id": "<string>",
  "userDefinedDemographic12Id": "<string>",
  "userDefinedDemographic13Id": "<string>",
  "userDefinedDemographic14Id": "<string>",
  "isCurrentGenderProtected": "<string>",
  "isGenderIdentityProtected": "<string>",
  "isPreferredPronounProtected": "<string>",
  "isSexualOrientationProtected": "<string>",
  "otherIdNumber": "<string>",
  "priorLastName": "<string>",
  "externalId": "<string>",
  "primaryDentalProviderId": "<string>",
  "primaryDentalProviderName": "<string>",
  "nickname": "<string>",
  "showContactInfoOnAlert": "<string>",
  "mothersMaidenName": "<string>",
  "hasEmail": "<string>",
  "hasPhoneNumber": "<string>",
  "usesPortal": "<string>",
  "usesSms": "<string>",
  "hasVoice": "<string>",
  "isOptOut": "<string>",
  "isHomePhoneNotApplicable": "<string>",
  "isCellPhoneNotApplicable": "<string>",
  "isAlternatePhoneNotApplicable": "<string>",
  "isDayPhoneNotApplicable": "<string>",
  "isSecondaryHomePhoneNotApplicable": "<string>",
  "isInternationalPhoneNotApplicable": "<string>",
  "isEmailNotApplicable": "<string>",
  "expiredDate": "<string>",
  "expiredTime": "<string>",
  "expiredTimeTz": "<string>",
  "birthMothersLastName": "<string>",
  "birthMothersFirstName": "<string>",
  "birthMothersMiddleName": "<string>",
  "exemptFromPersonMerge": "<string>",
  "addressTypeId": "<string>",
  "secondaryAddressTypeId": "<string>",
  "isEnterpriseChart": "<string>",
  "otherReasonSexualOrientation": "<string>",
  "_links": [
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    },
    {
      "href": "<string>",
      "method": "<string>",
      "rel": "<string>",
      "description": "<string>",
      "vendorExtensions": "<string>"
    }
  ]
}