POST api/PatientRegistration

Registers a new patient in Eye Reach Patients.

Request Information

URI Parameters

None.

Body Parameters

Model used to register the patient.

Name	Description	Type	Additional information
AccountNumber	Account number of the practice for which patient will be registered (Required).	string	None.
PatientId	(Read only) It will return the ID of the patient after the registration process.	globally unique identifier	None.
Username	User name of the patient for login into the portal (Required).	string	None.
Password	Password (Required).	string	None.
DateOfBirth	Date of birth of the patient (Required).	date	None.
Gender	Gender of the patient (Required). Possible values are Unspecified, Female, Male.	string	None.
SexId	Sex ID of the model in the portal.	integer	None.
Contact	Contact details of the patient (Required).	ContactModel	None.
TermsOfUseAccepted	Indicates if user has accepted the terms of use.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 1",
  "PatientId": "099afba7-e242-45dd-953b-69c923fc2856",
  "Username": "sample string 3",
  "Password": "sample string 4",
  "DateOfBirth": "2025-09-13T04:37:22.4811475-04:00",
  "Gender": "sample string 6",
  "SexId": 1,
  "Contact": {
    "FirstName": "sample string 1",
    "MiddleName": "sample string 2",
    "LastName": "sample string 3",
    "SuffixId": 4,
    "PrefixId": 5,
    "CompanyName": "sample string 6",
    "JobTitle": "sample string 7",
    "EmailAddresses": [
      {
        "Id": "1772f2dd-8911-416c-bca7-abfe490467da",
        "Alias": "sample string 2",
        "Address": "sample string 3",
        "Default": true,
        "SortOrder": 5
      },
      {
        "Id": "1772f2dd-8911-416c-bca7-abfe490467da",
        "Alias": "sample string 2",
        "Address": "sample string 3",
        "Default": true,
        "SortOrder": 5
      }
    ],
    "PhoneNumbers": [
      {
        "Id": "eb37acf4-8f6f-4d5f-aee2-f1116db6fd78",
        "Alias": "sample string 2",
        "Number": "sample string 3",
        "UseForVoice": true,
        "UseForSms": true,
        "SortOrder": 6
      },
      {
        "Id": "eb37acf4-8f6f-4d5f-aee2-f1116db6fd78",
        "Alias": "sample string 2",
        "Number": "sample string 3",
        "UseForVoice": true,
        "UseForSms": true,
        "SortOrder": 6
      }
    ],
    "PostalAddresses": [
      {
        "Id": "7cf5c9dd-46e6-4861-abdb-74484c8ba018",
        "Alias": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "CountryId": "31c54297-9e24-4211-bf83-e871fb59f10a",
        "CountryCode": "sample string 7",
        "CountryName": "sample string 8",
        "Zip": "sample string 9",
        "Default": true,
        "Latitude": 1.0,
        "Longitude": 1.0
      },
      {
        "Id": "7cf5c9dd-46e6-4861-abdb-74484c8ba018",
        "Alias": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "CountryId": "31c54297-9e24-4211-bf83-e871fb59f10a",
        "CountryCode": "sample string 7",
        "CountryName": "sample string 8",
        "Zip": "sample string 9",
        "Default": true,
        "Latitude": 1.0,
        "Longitude": 1.0
      }
    ],
    "Notes": "sample string 8"
  },
  "TermsOfUseAccepted": true
}

application/xml, text/xml

Sample:

<PatientRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientRegistration">
  <AccountNumber>sample string 1</AccountNumber>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 6</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>1772f2dd-8911-416c-bca7-abfe490467da</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>1772f2dd-8911-416c-bca7-abfe490467da</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:JobTitle>sample string 7</d2p1:JobTitle>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:MiddleName>sample string 2</d2p1:MiddleName>
    <d2p1:Notes>sample string 8</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Id>eb37acf4-8f6f-4d5f-aee2-f1116db6fd78</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
        <d2p1:UseForVoice>true</d2p1:UseForVoice>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Id>eb37acf4-8f6f-4d5f-aee2-f1116db6fd78</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
        <d2p1:UseForVoice>true</d2p1:UseForVoice>
      </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>31c54297-9e24-4211-bf83-e871fb59f10a</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>7cf5c9dd-46e6-4861-abdb-74484c8ba018</d2p1:Id>
        <d2p1:Latitude>1</d2p1:Latitude>
        <d2p1:Longitude>1</d2p1:Longitude>
        <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>31c54297-9e24-4211-bf83-e871fb59f10a</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>7cf5c9dd-46e6-4861-abdb-74484c8ba018</d2p1:Id>
        <d2p1:Latitude>1</d2p1:Latitude>
        <d2p1:Longitude>1</d2p1:Longitude>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:PrefixId>5</d2p1:PrefixId>
    <d2p1:SuffixId>4</d2p1:SuffixId>
  </Contact>
  <DateOfBirth>2025-09-13T04:37:22.4811475-04:00</DateOfBirth>
  <Gender>sample string 6</Gender>
  <Password>sample string 4</Password>
  <PatientId>099afba7-e242-45dd-953b-69c923fc2856</PatientId>
  <SexId>1</SexId>
  <TermsOfUseAccepted>true</TermsOfUseAccepted>
  <Username>sample string 3</Username>
</PatientRegistrationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientRegistrationModel

Name	Description	Type	Additional information
AccountNumber	Account number of the practice for which patient will be registered (Required).	string	None.
PatientId	(Read only) It will return the ID of the patient after the registration process.	globally unique identifier	None.
Username	User name of the patient for login into the portal (Required).	string	None.
Password	Password (Required).	string	None.
DateOfBirth	Date of birth of the patient (Required).	date	None.
Gender	Gender of the patient (Required). Possible values are Unspecified, Female, Male.	string	None.
SexId	Sex ID of the model in the portal.	integer	None.
Contact	Contact details of the patient (Required).	ContactModel	None.
TermsOfUseAccepted	Indicates if user has accepted the terms of use.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "AccountNumber": "sample string 1",
  "PatientId": "1b98a6cf-18f4-46e1-91fd-0c1274d84785",
  "Username": "sample string 3",
  "Password": "sample string 4",
  "DateOfBirth": "2025-09-13T04:37:22.5280295-04:00",
  "Gender": "sample string 6",
  "SexId": 1,
  "Contact": {
    "FirstName": "sample string 1",
    "MiddleName": "sample string 2",
    "LastName": "sample string 3",
    "SuffixId": 4,
    "PrefixId": 5,
    "CompanyName": "sample string 6",
    "JobTitle": "sample string 7",
    "EmailAddresses": [
      {
        "Id": "d1d5174c-07df-4ad9-b00e-222db3f85925",
        "Alias": "sample string 2",
        "Address": "sample string 3",
        "Default": true,
        "SortOrder": 5
      },
      {
        "Id": "d1d5174c-07df-4ad9-b00e-222db3f85925",
        "Alias": "sample string 2",
        "Address": "sample string 3",
        "Default": true,
        "SortOrder": 5
      }
    ],
    "PhoneNumbers": [
      {
        "Id": "57ff27c3-b8f2-47a0-8deb-d32c4c11be7d",
        "Alias": "sample string 2",
        "Number": "sample string 3",
        "UseForVoice": true,
        "UseForSms": true,
        "SortOrder": 6
      },
      {
        "Id": "57ff27c3-b8f2-47a0-8deb-d32c4c11be7d",
        "Alias": "sample string 2",
        "Number": "sample string 3",
        "UseForVoice": true,
        "UseForSms": true,
        "SortOrder": 6
      }
    ],
    "PostalAddresses": [
      {
        "Id": "1d382706-7732-4c58-8a65-35ac124b8923",
        "Alias": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "CountryId": "6406f689-8527-40fe-9569-e7cb46fef010",
        "CountryCode": "sample string 7",
        "CountryName": "sample string 8",
        "Zip": "sample string 9",
        "Default": true,
        "Latitude": 1.0,
        "Longitude": 1.0
      },
      {
        "Id": "1d382706-7732-4c58-8a65-35ac124b8923",
        "Alias": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "CountryId": "6406f689-8527-40fe-9569-e7cb46fef010",
        "CountryCode": "sample string 7",
        "CountryName": "sample string 8",
        "Zip": "sample string 9",
        "Default": true,
        "Latitude": 1.0,
        "Longitude": 1.0
      }
    ],
    "Notes": "sample string 8"
  },
  "TermsOfUseAccepted": true
}

application/xml, text/xml

Sample:

<PatientRegistrationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.PatientRegistration">
  <AccountNumber>sample string 1</AccountNumber>
  <Contact xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.Contacts">
    <d2p1:CompanyName>sample string 6</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>d1d5174c-07df-4ad9-b00e-222db3f85925</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>d1d5174c-07df-4ad9-b00e-222db3f85925</d2p1:Id>
        <d2p1:SortOrder>5</d2p1:SortOrder>
      </d2p1:EmailAddressModel>
    </d2p1:EmailAddresses>
    <d2p1:FirstName>sample string 1</d2p1:FirstName>
    <d2p1:JobTitle>sample string 7</d2p1:JobTitle>
    <d2p1:LastName>sample string 3</d2p1:LastName>
    <d2p1:MiddleName>sample string 2</d2p1:MiddleName>
    <d2p1:Notes>sample string 8</d2p1:Notes>
    <d2p1:PhoneNumbers>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Id>57ff27c3-b8f2-47a0-8deb-d32c4c11be7d</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
        <d2p1:UseForVoice>true</d2p1:UseForVoice>
      </d2p1:PhoneNumberModel>
      <d2p1:PhoneNumberModel>
        <d2p1:Alias>sample string 2</d2p1:Alias>
        <d2p1:Id>57ff27c3-b8f2-47a0-8deb-d32c4c11be7d</d2p1:Id>
        <d2p1:Number>sample string 3</d2p1:Number>
        <d2p1:SortOrder>6</d2p1:SortOrder>
        <d2p1:UseForSms>true</d2p1:UseForSms>
        <d2p1:UseForVoice>true</d2p1:UseForVoice>
      </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>6406f689-8527-40fe-9569-e7cb46fef010</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>1d382706-7732-4c58-8a65-35ac124b8923</d2p1:Id>
        <d2p1:Latitude>1</d2p1:Latitude>
        <d2p1:Longitude>1</d2p1:Longitude>
        <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>6406f689-8527-40fe-9569-e7cb46fef010</d2p1:CountryId>
        <d2p1:CountryName>sample string 8</d2p1:CountryName>
        <d2p1:Default>true</d2p1:Default>
        <d2p1:Id>1d382706-7732-4c58-8a65-35ac124b8923</d2p1:Id>
        <d2p1:Latitude>1</d2p1:Latitude>
        <d2p1:Longitude>1</d2p1:Longitude>
        <d2p1:State>sample string 6</d2p1:State>
        <d2p1:Zip>sample string 9</d2p1:Zip>
      </d2p1:PostalAddressModel>
    </d2p1:PostalAddresses>
    <d2p1:PrefixId>5</d2p1:PrefixId>
    <d2p1:SuffixId>4</d2p1:SuffixId>
  </Contact>
  <DateOfBirth>2025-09-13T04:37:22.5280295-04:00</DateOfBirth>
  <Gender>sample string 6</Gender>
  <Password>sample string 4</Password>
  <PatientId>1b98a6cf-18f4-46e1-91fd-0c1274d84785</PatientId>
  <SexId>1</SexId>
  <TermsOfUseAccepted>true</TermsOfUseAccepted>
  <Username>sample string 3</Username>
</PatientRegistrationModel>