GET api/Patients?externalId={externalId}

Gets information about a patient.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalId

Patient's unique ID on integrating system.

 string

Required

Body Parameters

None.

Response Information

Resource Description

PatientModel
NameDescriptionTypeAdditional information
Username

Username of the patient.

 string

None.
Password

Password of the patient.

 string

None.
Representative

Data of the patient representative.

 RepresentativeModel

None.
Birthday

Birthday of the patient.

 date

None.
ContactLensesReorderDate

Date in which the patient must reorder contact lenses (used in the Reorder Contact Lenses communication).

 date

None.
ContactLensesReorderName

check Contact lenses reorder name of the patient.

 string

None.
RecallDate1

Recall date 1 of the patient.

 date

None.
RecallDate2

Recall date 2 of the patient.

 date

None.
Notes

Notes about the patient.

 string

None.
Active

Indicates whether the patient is active or not.

 boolean

None.
AllowEmailReminders

Indicates whether the patient agrees to receive email reminders.

 boolean

None.
AllowEmailBirthday

Indicates whether the patient agrees to receive birthday greetings by email.

 boolean

None.
AllowEmailThankYou

Indicates whether the patient agrees to receive thank you messages by email.

 boolean

None.
AllowEmailEyeWear

Indicates whether the patient agrees to receive eyewear related messages by email.

 boolean

None.
AllowEmailPromotions

Indicates whether the patient agrees to receive promotional messages by email.

 boolean

None.
AllowSmsReminders

Indicates whether the patient agrees to receive SMS reminders.

 boolean

None.
AllowSmsBirthday

Indicates whether the patient agrees to receive birthday greetings by SMS.

 boolean

None.
AllowSmsThankYou

Indicates whether the patient agrees to receive thank you messages by SMS.

 boolean

None.
AllowSmsEyewear

Indicates whether the patient agrees to receive eyewear related messages by SMS.

 boolean

None.
AllowSmsPromotions

Indicates whether the patient agrees to receive promotional messages by SMS.

 boolean

None.
AllowVoiceReminders

Indicates whether the patient agrees to receive voice reminders.

 boolean

None.
AllowVoiceBirthday

Indicates whether the patient agrees to receive birthday greetings by voice.

 boolean

None.
AllowVoiceThankYou

Indicates whether the patient agrees to receive thank you messages by voice.

 boolean

None.
AllowVoiceEyewear

Indicates whether the patient agrees to receive eyewear related messages by voice.

 boolean

None.
AllowVoicePromotions

Indicates whether the patient agrees to receive promotional calls.

 boolean

None.
InvitedToPortal

Indicates whether the patient was invited to the web portal or not.

 boolean

None.
Locations

Locations that the patient has visited (Required).

 Collection of string

None.
Contact

Patient's contact information (Required).

 ContactModel

None.
Last4SSN

SSN last four digits.

 string

None.
NextLogOnSecurityVerificationPatient

Indicates whether the patient is required for next log on security verification or not.

 boolean

None.
NextLogOnSecurityVerificationRepresentative

Indicates wheter the patient representative is required for next log on security verification or not.

 boolean

None.
SexExternalId

Patient's sex unique ID on integrating system.

 string

None.
MaritalStatusExternalId

Patient's marital status unique ID on integrating system.

 string

None.
RaceExternalId

Patient's race unique ID on integrating system.

 string

None.
EthnicityExternalId

Patient's ethnicity unique ID on integrating system.

 string

None.
LanguageName

Preferred language of the patient.

 string

None.
PharmacyName

Pharmacy name.

 string

None.
PharmacyPhone

Pharmacy phone.

 string

None.
PharmacyAddress1

Pharmacy address 1.

 string

None.
PharmacyAddress2

Pharmacy address 2.

 string

None.
PharmacyCity

Pharmacy city.

 string

None.
PharmacyState

Pharmacy state.

 string

None.
PharmacyZip

Pharmacy ZIP.

 string

None.
PrimaryInsuranceName

Primary insurance name (Required while sending primary insurance information).

 string

None.
PrimaryInsuranceIdNumber

Primary insurance ID number (Required while sending primary insurance information).

 string

None.
PrimaryInsuranceGroupNumber

Primary insurance group number.

 string

None.
PrimaryInsuranceEmployerName

Primary insurance employer name.

 string

None.
PrimaryInsuranceAddress1

Primary insurance address 1.

 string

None.
PrimaryInsuranceAddress2

Primary insurance address 2.

 string

None.
PrimaryInsuranceCity

Primary insurance city.

 string

None.
PrimaryInsuranceState

Primary insurance state.

 string

None.
PrimaryInsuranceZip

Primary insurance ZIP.

 string

None.
PrimaryInsuranceInsuredPersonFirstName

Primary insurance. Insured person first name (Required while sending primary insurance information).

 string

None.
PrimaryInsuranceInsuredPersonMiddleName

Primary insurance. Insured person middle name.

 string

None.
PrimaryInsuranceInsuredPersonLastName

Primary insurance. Insured person last name (Required while sending primary insurance information).

 string

None.
PrimaryInsuranceInsuredPersonBirthday

Primary insurance. Insured person date of birth (Required while sending primary insurance information).

 date

None.
PrimaryInsuranceActivationDate

Activation date of the primary insurance.

 date

None.
PrimaryInsuranceCopay

Copay amount for the primary insurance.

 decimal number

None.
PrimaryInsuranceRelationshipToInsured

Primary insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending primary insurance information).

 string

None.
SecondaryInsuranceName

Secondary insurance name (Required while sending secondary insurance information). Enter the primary insurance information before you can specify a secondary insurance.

 string

None.
SecondaryInsuranceIdNumber

Secondary insurance ID number (Required while sending secondary insurance information).

 string

None.
SecondaryInsuranceGroupNumber

Secondary insurance group number.

 string

None.
SecondaryInsuranceEmployerName

Secondary insurance employer name.

 string

None.
SecondaryInsuranceAddress1

Secondary insurance address 1.

 string

None.
SecondaryInsuranceAddress2

Secondary insurance address 2.

 string

None.
SecondaryInsuranceCity

Secondary insurance city.

 string

None.
SecondaryInsuranceState

Secondary insurance state.

 string

None.
SecondaryInsuranceZip

Secondary insurance ZIP.

 string

None.
SecondaryInsuranceInsuredPersonFirstName

Secondary insurance. Insured person first name (Required while sending secondary insurance information).

 string

None.
SecondaryInsuranceInsuredPersonMiddleName

Secondary insurance. Insured person middle name.

 string

None.
SecondaryInsuranceInsuredPersonLastName

Secondary insurance. Insured person last name (Required while sending secondary insurance information).

 string

None.
SecondaryInsuranceInsuredPersonBirthday

Secondary insurance. Insured person date of birth (Required while sending secondary insurance information).

 date

None.
SecondaryInsuranceActivationDate

Activation date of the secondary insurance.

 date

None.
SecondaryInsuranceCopay

Copay amount for the secondary insurance.

 decimal number

None.
SecondaryInsuranceRelationshipToInsured

Secondary insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending secondary insurance information).

 string

None.
TertiaryInsuranceName

Tertiary insurance name (Required while sending tertiary insurance information). Enter the primary and secondary insurance information before you can specify a tertiary insurance.

 string

None.
TertiaryInsuranceIdNumber

Tertiary insurance ID number (Required while sending tertiary insurance information).

 string

None.
TertiaryInsuranceGroupNumber

Tertiary insurance group number.

 string

None.
TertiaryInsuranceEmployerName

Tertiary insurance employer name.

 string

None.
TertiaryInsuranceAddress1

Tertiary insurance address 1.

 string

None.
TertiaryInsuranceAddress2

Tertiary insurance address 2.

 string

None.
TertiaryInsuranceCity

Tertiary insurance city.

 string

None.
TertiaryInsuranceState

Tertiary insurance state.

 string

None.
TertiaryInsuranceZip

Tertiary insurance ZIP.

 string

None.
TertiaryInsuranceInsuredPersonFirstName

Tertiary insurance. Insured person first name (Required while sending tertiary insurance information).

 string

None.
TertiaryInsuranceInsuredPersonMiddleName

Tertiary insurance. Insured person middle name.

 string

None.
TertiaryInsuranceInsuredPersonLastName

Tertiary insurance. Insured person last name (Required while sending tertiary insurance information).

 string

None.
TertiaryInsuranceInsuredPersonBirthday

Tertiary insurance. Insured person date of birth (Required while sending tertiary insurance information).

 date

None.
TertiaryInsuranceActivationDate

Activation date of the tertiary insurance.

 date

None.
TertiaryInsuranceCopay

Gets or sets the copayment amount required by the patient's tertiary insurance provider.

 decimal number

None.
TertiaryInsuranceRelationshipToInsured

Tertiary insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending tertiary insurance information).

 string

None.
VisionInsuranceName

Vision insurance name (Required while sending vision insurance information).

 string

None.
VisionInsuranceIdNumber

Vision insurance ID number (Required while sending vision insurance information).

 string

None.
VisionInsuranceGroupNumber

Vision insurance group number.

 string

None.
VisionInsuranceEmployerName

Vision insurance employer name.

 string

None.
VisionInsuranceAddress1

Vision insurance address 1.

 string

None.
VisionInsuranceAddress2

Vision insurance address 2.

 string

None.
VisionInsuranceCity

Vision insurance city.

 string

None.
VisionInsuranceState

Vision insurance state.

 string

None.
VisionInsuranceZip

Vision insurance ZIP.

 string

None.
VisionInsuranceInsuredPersonFirstName

Vision insurance. Insured person first name (Required while sending vision insurance information).

 string

None.
VisionInsuranceInsuredPersonMiddleName

Vision insurance. Insured person middle name.

 string

None.
VisionInsuranceInsuredPersonLastName

Vision insurance. Insured person last name (Required while sending vision insurance information).

 string

None.
VisionInsuranceInsuredPersonBirthday

Vision insurance. Insured person date of birth (Required while sending vision insurance information).

 date

None.
VisionInsuranceActivationDate

Activation date of the vision insurance.

 date

None.
VisionInsuranceCopay

Copay amount for the vision insurance.

 decimal number

None.
VisionInsuranceRelationshipToInsured

Vision insurance. Relationship to insured person should be (Self, Spouse, Child, Other). (Required while sending vision insurance information).

 string

None.
ResponsiblePartyRelationshipToInsured

Gets or sets the relationship of the responsible party to the insured individual.

 string

None.
ResponsiblePartyPrefixId

Gets or sets the identifier prefix associated with the responsible party.

 string

None.
ResponsiblePartyPersonFirstName

Gets or sets the first name of the responsible party person.

 string

None.
ResponsiblePartyPersonMiddleName

Gets or sets the middle name of the responsible party person.

 string

None.
ResponsiblePartyPersonLastName

Gets or sets the last name of the responsible party person.

 string

None.
ResponsiblePartySuffixId

Gets or sets the identifier for the suffix associated with the responsible party.

 string

None.
ResponsiblePartyBirthday

Gets or sets the date of birth of the responsible party.

 date

None.
ResponsiblePartyEmailAddress

Gets or sets the email address of the responsible party associated with this entity.

 string

None.
ResponsiblePartyAddress1

Gets or sets the first line of the address for the responsible party.

 string

None.
ResponsiblePartyAddress2

Gets or sets the second line of the address for the responsible party.

 string

None.
ResponsiblePartyCity

Gets or sets the city of the responsible party.

 string

None.
ResponsiblePartyState

Gets or sets the state of the responsible party.

 string

None.
ResponsiblePartyZip

Gets or sets the ZIP code of the responsible party.

 string

None.
ResponsiblePartyVoicePhone

Gets or sets the voice phone number of the responsible party.

 string

None.
ResponsiblePartyTextPhone

Gets or sets the text phone number of the responsible party.

 string

None.
ResponsiblePartyWorkPhoneNumber

Gets or sets the work phone number of the responsible party.

 string

None.
ResponsiblePartyWorkPhoneNumberExt

Gets or sets the extension for the work phone number of the responsible party.

 string

None.
PrimaryCarePhysician

Primary care physician.

 string

None.
EmergencyContact1Name

Emergency contact 1 name.

 string

None.
EmergencyContact1Relationship

Emergency contact 1 relationship.

 string

None.
EmergencyContact1Address1

Emergency contact 1 address1.

 string

None.
EmergencyContact1Address2

Emergency contact 1 address2.

 string

None.
EmergencyContact1City

Emergency contact 1 city.

 string

None.
EmergencyContact1State

Emergency contact 1 state.

 string

None.
EmergencyContact1Zip

Emergency contact 1 zip.

 string

None.
EmergencyContact1CellphoneNumber

Emergency contact 1 cellphone number.

 string

None.
EmergencyContact1HomePhoneNumber

Emergency contact 1 home phone number.

 string

None.
EmergencyContact1WorkPhoneNumber

Emergency contact 1 work phone number.

 string

None.
EmergencyContact1EmailAddress

Emergency contact 1 email address.

 string

None.
EmergencyContact2Name

Emergency contact 2 name.

 string

None.
EmergencyContact2Relationship

Emergency contact 2 relationship.

 string

None.
EmergencyContact2Address1

Emergency contact 2 address1.

 string

None.
EmergencyContact2Address2

Emergency contact 2 address2

 string

None.
EmergencyContact2City

Emergency contact 2 city.

 string

None.
EmergencyContact2State

Emergency contact 2 state.

 string

None.
EmergencyContact2Zip

Emergency contact 2 zip.

 string

None.
EmergencyContact2CellphoneNumber

Emergency contact 2 cellphone number.

 string

None.
EmergencyContact2HomePhoneNumber

Emergency contact 2 home phone number.

 string

None.
EmergencyContact2WorkPhoneNumber

Emergency contact 2 work phone number.

 string

None.
EmergencyContact2EmailAddress

Emergency contact 2 email address.

 string

None.
CommunicationPreferences

Contains list of category communication preferences.

 Collection of PatientCategoryCommunicationPreferenceModel

None.
PracticeManagementSystemId

Practice management system ID.

 string

None.
MedicalRecordNumber

Medical record number of the patient.

 string

None.
Id

Unique ID of the model in the portal (Read only).

 globally unique identifier

None.
ExternalId

Unique ID of the model on integrating system (Required).

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "username": "sample string 1",
  "password": "sample string 2",
  "representative": {
    "externalId": "sample string 1",
    "username": "sample string 2",
    "password": "sample string 3",
    "email": "sample string 4",
    "firstName": "sample string 5",
    "lastName": "sample string 6"
  },
  "birthday": "2026-05-29T16:58:01.3750566+00:00",
  "contactLensesReorderDate": "2026-05-29T16:58:01.3750566+00:00",
  "contactLensesReorderName": "sample string 3",
  "recallDate1": "2026-05-29T16:58:01.3750566+00:00",
  "recallDate2": "2026-05-29T16:58:01.3750566+00:00",
  "notes": "sample string 4",
  "active": true,
  "allowEmailReminders": true,
  "allowEmailBirthday": true,
  "allowEmailThankYou": true,
  "allowEmailEyeWear": true,
  "allowEmailPromotions": true,
  "allowSmsReminders": true,
  "allowSmsBirthday": true,
  "allowSmsThankYou": true,
  "allowSmsEyewear": true,
  "allowSmsPromotions": true,
  "allowVoiceReminders": true,
  "allowVoiceBirthday": true,
  "allowVoiceThankYou": true,
  "allowVoiceEyewear": true,
  "allowVoicePromotions": true,
  "invitedToPortal": true,
  "locations": [
    "sample string 1",
    "sample string 2"
  ],
  "contact": {
    "id": "1381214b-7c72-428c-ab0f-82d764f183f6",
    "firstName": "sample string 2",
    "middleName": "sample string 3",
    "lastName": "sample string 4",
    "suffix": "sample string 5",
    "prefix": "sample string 6",
    "fullName": "sample string 7",
    "companyName": "sample string 8",
    "jobTitle": "sample string 9",
    "emailAddresses": [
      {
        "id": "d6d4bb0b-f425-4375-8cba-768eabc143d1",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      },
      {
        "id": "d6d4bb0b-f425-4375-8cba-768eabc143d1",
        "alias": "sample string 2",
        "address": "sample string 3",
        "default": true,
        "sortOrder": 5
      }
    ],
    "phoneNumbers": [
      {
        "id": "675bd8d0-f35c-4f2c-a690-860b969b178e",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      },
      {
        "id": "675bd8d0-f35c-4f2c-a690-860b969b178e",
        "alias": "sample string 2",
        "number": "sample string 3",
        "default": true,
        "useForSms": true,
        "sortOrder": 6
      }
    ],
    "postalAddresses": [
      {
        "id": "5b335df9-1c05-4d68-8a86-0e7a424f4462",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "36b5a96c-3cf9-4964-ae25-c492b246234d",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      },
      {
        "id": "5b335df9-1c05-4d68-8a86-0e7a424f4462",
        "alias": "sample string 2",
        "address1": "sample string 3",
        "address2": "sample string 4",
        "city": "sample string 5",
        "state": "sample string 6",
        "countryId": "36b5a96c-3cf9-4964-ae25-c492b246234d",
        "countryCode": "sample string 7",
        "countryName": "sample string 8",
        "zip": "sample string 9",
        "default": true
      }
    ],
    "notes": "sample string 10"
  },
  "last4SSN": "sample string 22",
  "nextLogOnSecurityVerificationPatient": true,
  "nextLogOnSecurityVerificationRepresentative": true,
  "sexExternalId": "sample string 23",
  "maritalStatusExternalId": "sample string 24",
  "raceExternalId": "sample string 25",
  "ethnicityExternalId": "sample string 26",
  "languageName": "sample string 27",
  "pharmacyName": "sample string 28",
  "pharmacyPhone": "sample string 29",
  "pharmacyAddress1": "sample string 30",
  "pharmacyAddress2": "sample string 31",
  "pharmacyCity": "sample string 32",
  "pharmacyState": "sample string 33",
  "pharmacyZip": "sample string 34",
  "primaryInsuranceName": "sample string 35",
  "primaryInsuranceIdNumber": "sample string 36",
  "primaryInsuranceGroupNumber": "sample string 37",
  "primaryInsuranceEmployerName": "sample string 38",
  "primaryInsuranceAddress1": "sample string 39",
  "primaryInsuranceAddress2": "sample string 40",
  "primaryInsuranceCity": "sample string 41",
  "primaryInsuranceState": "sample string 42",
  "primaryInsuranceZip": "sample string 43",
  "primaryInsuranceInsuredPersonFirstName": "sample string 44",
  "primaryInsuranceInsuredPersonMiddleName": "sample string 45",
  "primaryInsuranceInsuredPersonLastName": "sample string 46",
  "primaryInsuranceInsuredPersonBirthday": "2026-05-29T16:58:01.3750566+00:00",
  "primaryInsuranceActivationDate": "2026-05-29T16:58:01.3750566+00:00",
  "primaryInsuranceCopay": 1.0,
  "primaryInsuranceRelationshipToInsured": "sample string 47",
  "secondaryInsuranceName": "sample string 48",
  "secondaryInsuranceIdNumber": "sample string 49",
  "secondaryInsuranceGroupNumber": "sample string 50",
  "secondaryInsuranceEmployerName": "sample string 51",
  "secondaryInsuranceAddress1": "sample string 52",
  "secondaryInsuranceAddress2": "sample string 53",
  "secondaryInsuranceCity": "sample string 54",
  "secondaryInsuranceState": "sample string 55",
  "secondaryInsuranceZip": "sample string 56",
  "secondaryInsuranceInsuredPersonFirstName": "sample string 57",
  "secondaryInsuranceInsuredPersonMiddleName": "sample string 58",
  "secondaryInsuranceInsuredPersonLastName": "sample string 59",
  "secondaryInsuranceInsuredPersonBirthday": "2026-05-29T16:58:01.3750566+00:00",
  "secondaryInsuranceActivationDate": "2026-05-29T16:58:01.3750566+00:00",
  "secondaryInsuranceCopay": 1.0,
  "secondaryInsuranceRelationshipToInsured": "sample string 60",
  "tertiaryInsuranceName": "sample string 61",
  "tertiaryInsuranceIdNumber": "sample string 62",
  "tertiaryInsuranceGroupNumber": "sample string 63",
  "tertiaryInsuranceEmployerName": "sample string 64",
  "tertiaryInsuranceAddress1": "sample string 65",
  "tertiaryInsuranceAddress2": "sample string 66",
  "tertiaryInsuranceCity": "sample string 67",
  "tertiaryInsuranceState": "sample string 68",
  "tertiaryInsuranceZip": "sample string 69",
  "tertiaryInsuranceInsuredPersonFirstName": "sample string 70",
  "tertiaryInsuranceInsuredPersonMiddleName": "sample string 71",
  "tertiaryInsuranceInsuredPersonLastName": "sample string 72",
  "tertiaryInsuranceInsuredPersonBirthday": "2026-05-29T16:58:01.3750566+00:00",
  "tertiaryInsuranceActivationDate": "2026-05-29T16:58:01.3750566+00:00",
  "tertiaryInsuranceCopay": 1.0,
  "tertiaryInsuranceRelationshipToInsured": "sample string 73",
  "visionInsuranceName": "sample string 74",
  "visionInsuranceIdNumber": "sample string 75",
  "visionInsuranceGroupNumber": "sample string 76",
  "visionInsuranceEmployerName": "sample string 77",
  "visionInsuranceAddress1": "sample string 78",
  "visionInsuranceAddress2": "sample string 79",
  "visionInsuranceCity": "sample string 80",
  "visionInsuranceState": "sample string 81",
  "visionInsuranceZip": "sample string 82",
  "visionInsuranceInsuredPersonFirstName": "sample string 83",
  "visionInsuranceInsuredPersonMiddleName": "sample string 84",
  "visionInsuranceInsuredPersonLastName": "sample string 85",
  "visionInsuranceInsuredPersonBirthday": "2026-05-29T16:58:01.3750566+00:00",
  "visionInsuranceActivationDate": "2026-05-29T16:58:01.3750566+00:00",
  "visionInsuranceCopay": 1.0,
  "visionInsuranceRelationshipToInsured": "sample string 86",
  "responsiblePartyRelationshipToInsured": "sample string 87",
  "responsiblePartyPrefixId": "sample string 88",
  "responsiblePartyPersonFirstName": "sample string 89",
  "responsiblePartyPersonMiddleName": "sample string 90",
  "responsiblePartyPersonLastName": "sample string 91",
  "responsiblePartySuffixId": "sample string 92",
  "responsiblePartyBirthday": "2026-05-29T16:58:01.3750566+00:00",
  "responsiblePartyEmailAddress": "sample string 93",
  "responsiblePartyAddress1": "sample string 94",
  "responsiblePartyAddress2": "sample string 95",
  "responsiblePartyCity": "sample string 96",
  "responsiblePartyState": "sample string 97",
  "responsiblePartyZip": "sample string 98",
  "responsiblePartyVoicePhone": "sample string 99",
  "responsiblePartyTextPhone": "sample string 100",
  "responsiblePartyWorkPhoneNumber": "sample string 101",
  "responsiblePartyWorkPhoneNumberExt": "sample string 102",
  "primaryCarePhysician": "sample string 103",
  "emergencyContact1Name": "sample string 104",
  "emergencyContact1Relationship": "sample string 105",
  "emergencyContact1Address1": "sample string 106",
  "emergencyContact1Address2": "sample string 107",
  "emergencyContact1City": "sample string 108",
  "emergencyContact1State": "sample string 109",
  "emergencyContact1Zip": "sample string 110",
  "emergencyContact1CellphoneNumber": "sample string 111",
  "emergencyContact1HomePhoneNumber": "sample string 112",
  "emergencyContact1WorkPhoneNumber": "sample string 113",
  "emergencyContact1EmailAddress": "sample string 114",
  "emergencyContact2Name": "sample string 115",
  "emergencyContact2Relationship": "sample string 116",
  "emergencyContact2Address1": "sample string 117",
  "emergencyContact2Address2": "sample string 118",
  "emergencyContact2City": "sample string 119",
  "emergencyContact2State": "sample string 120",
  "emergencyContact2Zip": "sample string 121",
  "emergencyContact2CellphoneNumber": "sample string 122",
  "emergencyContact2HomePhoneNumber": "sample string 123",
  "emergencyContact2WorkPhoneNumber": "sample string 124",
  "emergencyContact2EmailAddress": "sample string 125",
  "communicationPreferences": [
    {
      "categoryId": 1,
      "allowVoice": true,
      "allowEmail": true,
      "allowSms": true
    },
    {
      "categoryId": 1,
      "allowVoice": true,
      "allowEmail": true,
      "allowSms": true
    }
  ],
  "practiceManagementSystemId": "sample string 126",
  "medicalRecordNumber": "sample string 127",
  "id": "0f67fa0b-1026-446a-badd-21775b8bf717",
  "externalId": "sample string 129"
}

application/xml, text/xml

Sample: 
<PatientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Patients">
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">sample string 129</ExternalId>
  <Id xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models">0f67fa0b-1026-446a-badd-21775b8bf717</Id>
  <Active>true</Active>
  <AllowEmailBirthday>true</AllowEmailBirthday>
  <AllowEmailEyeWear>true</AllowEmailEyeWear>
  <AllowEmailPromotions>true</AllowEmailPromotions>
  <AllowEmailReminders>true</AllowEmailReminders>
  <AllowEmailThankYou>true</AllowEmailThankYou>
  <AllowSmsBirthday>true</AllowSmsBirthday>
  <AllowSmsEyewear>true</AllowSmsEyewear>
  <AllowSmsPromotions>true</AllowSmsPromotions>
  <AllowSmsReminders>true</AllowSmsReminders>
  <AllowSmsThankYou>true</AllowSmsThankYou>
  <AllowVoiceBirthday>true</AllowVoiceBirthday>
  <AllowVoiceEyewear>true</AllowVoiceEyewear>
  <AllowVoicePromotions>true</AllowVoicePromotions>
  <AllowVoiceReminders>true</AllowVoiceReminders>
  <AllowVoiceThankYou>true</AllowVoiceThankYou>
  <Birthday>2026-05-29T16:58:01.3750566+00:00</Birthday>
  <CommunicationPreferences xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.PatientCategoryCommunicationPreferences">
    <d2p1:PatientCategoryCommunicationPreferenceModel>
      <d2p1:AllowEmail>true</d2p1:AllowEmail>
      <d2p1:AllowSms>true</d2p1:AllowSms>
      <d2p1:AllowVoice>true</d2p1:AllowVoice>
      <d2p1:CategoryId>1</d2p1:CategoryId>
    </d2p1:PatientCategoryCommunicationPreferenceModel>
    <d2p1:PatientCategoryCommunicationPreferenceModel>
      <d2p1:AllowEmail>true</d2p1:AllowEmail>
      <d2p1:AllowSms>true</d2p1:AllowSms>
      <d2p1:AllowVoice>true</d2p1:AllowVoice>
      <d2p1:CategoryId>1</d2p1:CategoryId>
    </d2p1:PatientCategoryCommunicationPreferenceModel>
  </CommunicationPreferences>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 8</d2p1:CompanyName>
    <d2p1:EmailAddresses>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>d6d4bb0b-f425-4375-8cba-768eabc143d1</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
      <d2p1:EmailAddressModel>
        <d2p1:Address>sample string 3</d2p1:Address>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>d6d4bb0b-f425-4375-8cba-768eabc143d1</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 2</d2p1:FirstName>
    <d2p1:FullName>sample string 7</d2p1:FullName>
    <d2p1:Id>1381214b-7c72-428c-ab0f-82d764f183f6</d2p1:Id>
    <d2p1:JobTitle>sample string 9</d2p1:JobTitle>
    <d2p1:LastName>sample string 4</d2p1:LastName>
    <d2p1:MiddleName>sample string 3</d2p1:MiddleName>
    <d2p1:Notes>sample string 10</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>675bd8d0-f35c-4f2c-a690-860b969b178e</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>675bd8d0-f35c-4f2c-a690-860b969b178e</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
      </d2p1:PhoneNumberModel>
    </d2p1:PhoneNumbers>
    <d2p1:PostalAddresses>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>36b5a96c-3cf9-4964-ae25-c492b246234d</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>5b335df9-1c05-4d68-8a86-0e7a424f4462</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
      <d2p1:PostalAddressModel>
        <d2p1:Address1>sample string 3</d2p1:Address1>
        <d2p1:Address2>sample string 4</d2p1:Address2>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:City>sample string 5</d2p1:City>
        <d2p1:CountryCode>sample string 7</d2p1:CountryCode>
        <d2p1:CountryId>36b5a96c-3cf9-4964-ae25-c492b246234d</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>5b335df9-1c05-4d68-8a86-0e7a424f4462</d2p1:Id>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:Prefix>sample string 6</d2p1:Prefix>
    <d2p1:Suffix>sample string 5</d2p1:Suffix>
  </Contact>
  <ContactLensesReorderDate>2026-05-29T16:58:01.3750566+00:00</ContactLensesReorderDate>
  <ContactLensesReorderName>sample string 3</ContactLensesReorderName>
  <EmergencyContact1Address1>sample string 106</EmergencyContact1Address1>
  <EmergencyContact1Address2>sample string 107</EmergencyContact1Address2>
  <EmergencyContact1CellphoneNumber>sample string 111</EmergencyContact1CellphoneNumber>
  <EmergencyContact1City>sample string 108</EmergencyContact1City>
  <EmergencyContact1EmailAddress>sample string 114</EmergencyContact1EmailAddress>
  <EmergencyContact1HomePhoneNumber>sample string 112</EmergencyContact1HomePhoneNumber>
  <EmergencyContact1Name>sample string 104</EmergencyContact1Name>
  <EmergencyContact1Relationship>sample string 105</EmergencyContact1Relationship>
  <EmergencyContact1State>sample string 109</EmergencyContact1State>
  <EmergencyContact1WorkPhoneNumber>sample string 113</EmergencyContact1WorkPhoneNumber>
  <EmergencyContact1Zip>sample string 110</EmergencyContact1Zip>
  <EmergencyContact2Address1>sample string 117</EmergencyContact2Address1>
  <EmergencyContact2Address2>sample string 118</EmergencyContact2Address2>
  <EmergencyContact2CellphoneNumber>sample string 122</EmergencyContact2CellphoneNumber>
  <EmergencyContact2City>sample string 119</EmergencyContact2City>
  <EmergencyContact2EmailAddress>sample string 125</EmergencyContact2EmailAddress>
  <EmergencyContact2HomePhoneNumber>sample string 123</EmergencyContact2HomePhoneNumber>
  <EmergencyContact2Name>sample string 115</EmergencyContact2Name>
  <EmergencyContact2Relationship>sample string 116</EmergencyContact2Relationship>
  <EmergencyContact2State>sample string 120</EmergencyContact2State>
  <EmergencyContact2WorkPhoneNumber>sample string 124</EmergencyContact2WorkPhoneNumber>
  <EmergencyContact2Zip>sample string 121</EmergencyContact2Zip>
  <EthnicityExternalId>sample string 26</EthnicityExternalId>
  <InvitedToPortal>true</InvitedToPortal>
  <LanguageName>sample string 27</LanguageName>
  <Last4SSN>sample string 22</Last4SSN>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Locations>
  <MaritalStatusExternalId>sample string 24</MaritalStatusExternalId>
  <MedicalRecordNumber>sample string 127</MedicalRecordNumber>
  <NextLogOnSecurityVerificationPatient>true</NextLogOnSecurityVerificationPatient>
  <NextLogOnSecurityVerificationRepresentative>true</NextLogOnSecurityVerificationRepresentative>
  <Notes>sample string 4</Notes>
  <Password>sample string 2</Password>
  <PharmacyAddress1>sample string 30</PharmacyAddress1>
  <PharmacyAddress2>sample string 31</PharmacyAddress2>
  <PharmacyCity>sample string 32</PharmacyCity>
  <PharmacyName>sample string 28</PharmacyName>
  <PharmacyPhone>sample string 29</PharmacyPhone>
  <PharmacyState>sample string 33</PharmacyState>
  <PharmacyZip>sample string 34</PharmacyZip>
  <PracticeManagementSystemId>sample string 126</PracticeManagementSystemId>
  <PrimaryCarePhysician>sample string 103</PrimaryCarePhysician>
  <PrimaryInsuranceActivationDate>2026-05-29T16:58:01.3750566+00:00</PrimaryInsuranceActivationDate>
  <PrimaryInsuranceAddress1>sample string 39</PrimaryInsuranceAddress1>
  <PrimaryInsuranceAddress2>sample string 40</PrimaryInsuranceAddress2>
  <PrimaryInsuranceCity>sample string 41</PrimaryInsuranceCity>
  <PrimaryInsuranceCopay>1</PrimaryInsuranceCopay>
  <PrimaryInsuranceEmployerName>sample string 38</PrimaryInsuranceEmployerName>
  <PrimaryInsuranceGroupNumber>sample string 37</PrimaryInsuranceGroupNumber>
  <PrimaryInsuranceIdNumber>sample string 36</PrimaryInsuranceIdNumber>
  <PrimaryInsuranceInsuredPersonBirthday>2026-05-29T16:58:01.3750566+00:00</PrimaryInsuranceInsuredPersonBirthday>
  <PrimaryInsuranceInsuredPersonFirstName>sample string 44</PrimaryInsuranceInsuredPersonFirstName>
  <PrimaryInsuranceInsuredPersonLastName>sample string 46</PrimaryInsuranceInsuredPersonLastName>
  <PrimaryInsuranceInsuredPersonMiddleName>sample string 45</PrimaryInsuranceInsuredPersonMiddleName>
  <PrimaryInsuranceName>sample string 35</PrimaryInsuranceName>
  <PrimaryInsuranceRelationshipToInsured>sample string 47</PrimaryInsuranceRelationshipToInsured>
  <PrimaryInsuranceState>sample string 42</PrimaryInsuranceState>
  <PrimaryInsuranceZip>sample string 43</PrimaryInsuranceZip>
  <RaceExternalId>sample string 25</RaceExternalId>
  <RecallDate1>2026-05-29T16:58:01.3750566+00:00</RecallDate1>
  <RecallDate2>2026-05-29T16:58:01.3750566+00:00</RecallDate2>
  <Representative>
    <Email>sample string 4</Email>
    <ExternalId>sample string 1</ExternalId>
    <FirstName>sample string 5</FirstName>
    <LastName>sample string 6</LastName>
    <Password>sample string 3</Password>
    <Username>sample string 2</Username>
  </Representative>
  <ResponsiblePartyAddress1>sample string 94</ResponsiblePartyAddress1>
  <ResponsiblePartyAddress2>sample string 95</ResponsiblePartyAddress2>
  <ResponsiblePartyBirthday>2026-05-29T16:58:01.3750566+00:00</ResponsiblePartyBirthday>
  <ResponsiblePartyCity>sample string 96</ResponsiblePartyCity>
  <ResponsiblePartyEmailAddress>sample string 93</ResponsiblePartyEmailAddress>
  <ResponsiblePartyPersonFirstName>sample string 89</ResponsiblePartyPersonFirstName>
  <ResponsiblePartyPersonLastName>sample string 91</ResponsiblePartyPersonLastName>
  <ResponsiblePartyPersonMiddleName>sample string 90</ResponsiblePartyPersonMiddleName>
  <ResponsiblePartyPrefixId>sample string 88</ResponsiblePartyPrefixId>
  <ResponsiblePartyRelationshipToInsured>sample string 87</ResponsiblePartyRelationshipToInsured>
  <ResponsiblePartyState>sample string 97</ResponsiblePartyState>
  <ResponsiblePartySuffixId>sample string 92</ResponsiblePartySuffixId>
  <ResponsiblePartyTextPhone>sample string 100</ResponsiblePartyTextPhone>
  <ResponsiblePartyVoicePhone>sample string 99</ResponsiblePartyVoicePhone>
  <ResponsiblePartyWorkPhoneNumber>sample string 101</ResponsiblePartyWorkPhoneNumber>
  <ResponsiblePartyWorkPhoneNumberExt>sample string 102</ResponsiblePartyWorkPhoneNumberExt>
  <ResponsiblePartyZip>sample string 98</ResponsiblePartyZip>
  <SecondaryInsuranceActivationDate>2026-05-29T16:58:01.3750566+00:00</SecondaryInsuranceActivationDate>
  <SecondaryInsuranceAddress1>sample string 52</SecondaryInsuranceAddress1>
  <SecondaryInsuranceAddress2>sample string 53</SecondaryInsuranceAddress2>
  <SecondaryInsuranceCity>sample string 54</SecondaryInsuranceCity>
  <SecondaryInsuranceCopay>1</SecondaryInsuranceCopay>
  <SecondaryInsuranceEmployerName>sample string 51</SecondaryInsuranceEmployerName>
  <SecondaryInsuranceGroupNumber>sample string 50</SecondaryInsuranceGroupNumber>
  <SecondaryInsuranceIdNumber>sample string 49</SecondaryInsuranceIdNumber>
  <SecondaryInsuranceInsuredPersonBirthday>2026-05-29T16:58:01.3750566+00:00</SecondaryInsuranceInsuredPersonBirthday>
  <SecondaryInsuranceInsuredPersonFirstName>sample string 57</SecondaryInsuranceInsuredPersonFirstName>
  <SecondaryInsuranceInsuredPersonLastName>sample string 59</SecondaryInsuranceInsuredPersonLastName>
  <SecondaryInsuranceInsuredPersonMiddleName>sample string 58</SecondaryInsuranceInsuredPersonMiddleName>
  <SecondaryInsuranceName>sample string 48</SecondaryInsuranceName>
  <SecondaryInsuranceRelationshipToInsured>sample string 60</SecondaryInsuranceRelationshipToInsured>
  <SecondaryInsuranceState>sample string 55</SecondaryInsuranceState>
  <SecondaryInsuranceZip>sample string 56</SecondaryInsuranceZip>
  <SexExternalId>sample string 23</SexExternalId>
  <TertiaryInsuranceActivationDate>2026-05-29T16:58:01.3750566+00:00</TertiaryInsuranceActivationDate>
  <TertiaryInsuranceAddress1>sample string 65</TertiaryInsuranceAddress1>
  <TertiaryInsuranceAddress2>sample string 66</TertiaryInsuranceAddress2>
  <TertiaryInsuranceCity>sample string 67</TertiaryInsuranceCity>
  <TertiaryInsuranceCopay>1</TertiaryInsuranceCopay>
  <TertiaryInsuranceEmployerName>sample string 64</TertiaryInsuranceEmployerName>
  <TertiaryInsuranceGroupNumber>sample string 63</TertiaryInsuranceGroupNumber>
  <TertiaryInsuranceIdNumber>sample string 62</TertiaryInsuranceIdNumber>
  <TertiaryInsuranceInsuredPersonBirthday>2026-05-29T16:58:01.3750566+00:00</TertiaryInsuranceInsuredPersonBirthday>
  <TertiaryInsuranceInsuredPersonFirstName>sample string 70</TertiaryInsuranceInsuredPersonFirstName>
  <TertiaryInsuranceInsuredPersonLastName>sample string 72</TertiaryInsuranceInsuredPersonLastName>
  <TertiaryInsuranceInsuredPersonMiddleName>sample string 71</TertiaryInsuranceInsuredPersonMiddleName>
  <TertiaryInsuranceName>sample string 61</TertiaryInsuranceName>
  <TertiaryInsuranceRelationshipToInsured>sample string 73</TertiaryInsuranceRelationshipToInsured>
  <TertiaryInsuranceState>sample string 68</TertiaryInsuranceState>
  <TertiaryInsuranceZip>sample string 69</TertiaryInsuranceZip>
  <Username>sample string 1</Username>
  <VisionInsuranceActivationDate>2026-05-29T16:58:01.3750566+00:00</VisionInsuranceActivationDate>
  <VisionInsuranceAddress1>sample string 78</VisionInsuranceAddress1>
  <VisionInsuranceAddress2>sample string 79</VisionInsuranceAddress2>
  <VisionInsuranceCity>sample string 80</VisionInsuranceCity>
  <VisionInsuranceCopay>1</VisionInsuranceCopay>
  <VisionInsuranceEmployerName>sample string 77</VisionInsuranceEmployerName>
  <VisionInsuranceGroupNumber>sample string 76</VisionInsuranceGroupNumber>
  <VisionInsuranceIdNumber>sample string 75</VisionInsuranceIdNumber>
  <VisionInsuranceInsuredPersonBirthday>2026-05-29T16:58:01.3750566+00:00</VisionInsuranceInsuredPersonBirthday>
  <VisionInsuranceInsuredPersonFirstName>sample string 83</VisionInsuranceInsuredPersonFirstName>
  <VisionInsuranceInsuredPersonLastName>sample string 85</VisionInsuranceInsuredPersonLastName>
  <VisionInsuranceInsuredPersonMiddleName>sample string 84</VisionInsuranceInsuredPersonMiddleName>
  <VisionInsuranceName>sample string 74</VisionInsuranceName>
  <VisionInsuranceRelationshipToInsured>sample string 86</VisionInsuranceRelationshipToInsured>
  <VisionInsuranceState>sample string 81</VisionInsuranceState>
  <VisionInsuranceZip>sample string 82</VisionInsuranceZip>
</PatientModel>