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": "0c9ede51-52fd-4b09-a3f2-c80f881deea7", "Username": "sample string 3", "Password": "sample string 4", "DateOfBirth": "2024-04-26T06:55:39.9874334-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": "5bb8043c-69bb-4f47-abb8-68d69a4f2a11", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 }, { "Id": "5bb8043c-69bb-4f47-abb8-68d69a4f2a11", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 } ], "PhoneNumbers": [ { "Id": "3b152699-bb11-4f38-ac20-bbdc53484461", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 }, { "Id": "3b152699-bb11-4f38-ac20-bbdc53484461", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 } ], "PostalAddresses": [ { "Id": "2e0a2754-399e-49d7-9667-bd06090f3f0b", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "42724665-b001-4def-88ba-a6ffb6bac544", "CountryCode": "sample string 7", "CountryName": "sample string 8", "Zip": "sample string 9", "Default": true, "Latitude": 1.0, "Longitude": 1.0 }, { "Id": "2e0a2754-399e-49d7-9667-bd06090f3f0b", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "42724665-b001-4def-88ba-a6ffb6bac544", "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>5bb8043c-69bb-4f47-abb8-68d69a4f2a11</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>5bb8043c-69bb-4f47-abb8-68d69a4f2a11</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>3b152699-bb11-4f38-ac20-bbdc53484461</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>3b152699-bb11-4f38-ac20-bbdc53484461</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>42724665-b001-4def-88ba-a6ffb6bac544</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>2e0a2754-399e-49d7-9667-bd06090f3f0b</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>42724665-b001-4def-88ba-a6ffb6bac544</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>2e0a2754-399e-49d7-9667-bd06090f3f0b</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>2024-04-26T06:55:39.9874334-04:00</DateOfBirth> <Gender>sample string 6</Gender> <Password>sample string 4</Password> <PatientId>0c9ede51-52fd-4b09-a3f2-c80f881deea7</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": "6723b5ea-d404-4c54-b85c-33fb498c70f0", "Username": "sample string 3", "Password": "sample string 4", "DateOfBirth": "2024-04-26T06:55:40.0186841-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": "4d38203f-376a-4c73-8a53-91cc4ce1dc84", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 }, { "Id": "4d38203f-376a-4c73-8a53-91cc4ce1dc84", "Alias": "sample string 2", "Address": "sample string 3", "Default": true, "SortOrder": 5 } ], "PhoneNumbers": [ { "Id": "3ee798ef-6c24-4d10-a627-1ef0a4dcdeda", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 }, { "Id": "3ee798ef-6c24-4d10-a627-1ef0a4dcdeda", "Alias": "sample string 2", "Number": "sample string 3", "UseForVoice": true, "UseForSms": true, "SortOrder": 6 } ], "PostalAddresses": [ { "Id": "1255fa82-5afb-4e91-a953-760f90a35981", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "5d8963d2-ad6d-4721-9ca7-7b012abd40b1", "CountryCode": "sample string 7", "CountryName": "sample string 8", "Zip": "sample string 9", "Default": true, "Latitude": 1.0, "Longitude": 1.0 }, { "Id": "1255fa82-5afb-4e91-a953-760f90a35981", "Alias": "sample string 2", "Address1": "sample string 3", "Address2": "sample string 4", "City": "sample string 5", "State": "sample string 6", "CountryId": "5d8963d2-ad6d-4721-9ca7-7b012abd40b1", "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>4d38203f-376a-4c73-8a53-91cc4ce1dc84</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>4d38203f-376a-4c73-8a53-91cc4ce1dc84</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>3ee798ef-6c24-4d10-a627-1ef0a4dcdeda</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>3ee798ef-6c24-4d10-a627-1ef0a4dcdeda</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>5d8963d2-ad6d-4721-9ca7-7b012abd40b1</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>1255fa82-5afb-4e91-a953-760f90a35981</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>5d8963d2-ad6d-4721-9ca7-7b012abd40b1</d2p1:CountryId> <d2p1:CountryName>sample string 8</d2p1:CountryName> <d2p1:Default>true</d2p1:Default> <d2p1:Id>1255fa82-5afb-4e91-a953-760f90a35981</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>2024-04-26T06:55:40.0186841-04:00</DateOfBirth> <Gender>sample string 6</Gender> <Password>sample string 4</Password> <PatientId>6723b5ea-d404-4c54-b85c-33fb498c70f0</PatientId> <SexId>1</SexId> <TermsOfUseAccepted>true</TermsOfUseAccepted> <Username>sample string 3</Username> </PatientRegistrationModel>