POST api/PatientRegistration
Registers a new patient in Eye Reach Patients.
Request Information
URI Parameters
None.
Body Parameters
Model used to register the patient.
PatientRegistrationModelName | 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
{ "AccountNumber": "sample string 1", "PatientId": "bfbc3c7d-ea55-4687-a549-d7f554a25f74", "Username": "sample string 3", "Password": "sample string 4", "DateOfBirth": "2025-09-15T16:14:02.0537765-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": "f9cc7786-a942-4da6-b97e-b6655ff02dc9", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 }, { "Id": "f9cc7786-a942-4da6-b97e-b6655ff02dc9", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 } ], "PhoneNumbers": [ { "Id": "7c7c44c4-bd93-4217-80cf-e09af6956d4d", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 }, { "Id": "7c7c44c4-bd93-4217-80cf-e09af6956d4d", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 } ], "PostalAddresses": [ { "Id": "2046f2fc-09e6-43fe-94f9-bf4458545e5a", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "8eb0956a-4b8b-4e3e-ab1b-751445d7101f", "CountryCode": "sample string 7", "CountryName": "sample string 8", "Zip": "sample string 9", "Default": true, "Latitude": 1.0, "Longitude": 1.0 }, { "Id": "2046f2fc-09e6-43fe-94f9-bf4458545e5a", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "8eb0956a-4b8b-4e3e-ab1b-751445d7101f", "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
<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>f9cc7786-a942-4da6-b97e-b6655ff02dc9</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>f9cc7786-a942-4da6-b97e-b6655ff02dc9</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>7c7c44c4-bd93-4217-80cf-e09af6956d4d</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>7c7c44c4-bd93-4217-80cf-e09af6956d4d</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>8eb0956a-4b8b-4e3e-ab1b-751445d7101f</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>2046f2fc-09e6-43fe-94f9-bf4458545e5a</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>8eb0956a-4b8b-4e3e-ab1b-751445d7101f</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>2046f2fc-09e6-43fe-94f9-bf4458545e5a</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-15T16:14:02.0537765-04:00</DateOfBirth> <Gender>sample string 6</Gender> <Password>sample string 4</Password> <PatientId>bfbc3c7d-ea55-4687-a549-d7f554a25f74</PatientId> <SexId>1</SexId> <TermsOfUseAccepted>true</TermsOfUseAccepted> <Username>sample string 3</Username> </PatientRegistrationModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
PatientRegistrationModelName | 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
{ "AccountNumber": "sample string 1", "PatientId": "d9d8b001-1f11-4dab-99b1-581dbf30ff6f", "Username": "sample string 3", "Password": "sample string 4", "DateOfBirth": "2025-09-15T16:14:02.1162811-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": "fd927deb-50ec-4899-a109-8b1a912991d7", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 }, { "Id": "fd927deb-50ec-4899-a109-8b1a912991d7", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 } ], "PhoneNumbers": [ { "Id": "f6a01f59-d21a-4306-bf34-c3be1f3859f8", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 }, { "Id": "f6a01f59-d21a-4306-bf34-c3be1f3859f8", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 } ], "PostalAddresses": [ { "Id": "9411b041-75ec-48cf-950b-20d625f11492", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "18258d06-9d46-4c7f-86a4-cc9ae4d86565", "CountryCode": "sample string 7", "CountryName": "sample string 8", "Zip": "sample string 9", "Default": true, "Latitude": 1.0, "Longitude": 1.0 }, { "Id": "9411b041-75ec-48cf-950b-20d625f11492", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "18258d06-9d46-4c7f-86a4-cc9ae4d86565", "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
<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>fd927deb-50ec-4899-a109-8b1a912991d7</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>fd927deb-50ec-4899-a109-8b1a912991d7</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>f6a01f59-d21a-4306-bf34-c3be1f3859f8</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>f6a01f59-d21a-4306-bf34-c3be1f3859f8</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>18258d06-9d46-4c7f-86a4-cc9ae4d86565</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>9411b041-75ec-48cf-950b-20d625f11492</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>18258d06-9d46-4c7f-86a4-cc9ae4d86565</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>9411b041-75ec-48cf-950b-20d625f11492</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-15T16:14:02.1162811-04:00</DateOfBirth> <Gender>sample string 6</Gender> <Password>sample string 4</Password> <PatientId>d9d8b001-1f11-4dab-99b1-581dbf30ff6f</PatientId> <SexId>1</SexId> <TermsOfUseAccepted>true</TermsOfUseAccepted> <Username>sample string 3</Username> </PatientRegistrationModel>