POST api/v1/{EMRSystem}/Patients
Creates a new Patient.
Status: Released
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmPatientCreateRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| FacilityId |
Gets or sets the facility identifier |
string |
Required if EMRSystem = Meditech, or Epic, or Cerner |
| InterpreterTypeId |
Gets or sets the InterpreterTypeId. |
string |
None. |
| Patient |
Gets or sets the patient. |
PatientCreate |
Required |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Request Formats
application/json
{
"UserId": "sample string 1",
"FacilityId": "sample string 2",
"InterpreterTypeId": "sample string 3",
"Patient": {
"DeceasedDateTime": "2025-12-12T21:05:49.7854427+00:00",
"LastName": "sample string 1",
"FirstName": "sample string 2",
"MiddleName": "sample string 3",
"Suffix": "sample string 4",
"Prefix": "sample string 5",
"BirthDateTime": "2025-12-12T21:05:49.7868963+00:00",
"GenderId": "sample string 6",
"SSN": "sample string 7",
"VipId": "sample string 8",
"ConfidentialityId": "sample string 9",
"SystemId": "sample string 10",
"Identities": [
{
"SubTypeId": "sample string 1",
"Value": "sample string 2"
},
{
"SubTypeId": "sample string 1",
"Value": "sample string 2"
}
],
"ExtendedInfo": {
"Addresses": [
{
"Address1": "sample string 1",
"Address2": "sample string 2",
"Address3": "sample string 3",
"City": "sample string 4",
"State": "sample string 5",
"ZIP": "sample string 6",
"TypeId": "sample string 7",
"County": "sample string 8",
"Country": "sample string 9"
},
{
"Address1": "sample string 1",
"Address2": "sample string 2",
"Address3": "sample string 3",
"City": "sample string 4",
"State": "sample string 5",
"ZIP": "sample string 6",
"TypeId": "sample string 7",
"County": "sample string 8",
"Country": "sample string 9"
}
],
"Phones": [
{
"Number": "sample string 1",
"TypeId": "sample string 2",
"Extension": "sample string 3",
"FormatId": "sample string 4",
"Contact": "sample string 5"
},
{
"Number": "sample string 1",
"TypeId": "sample string 2",
"Extension": "sample string 3",
"FormatId": "sample string 4",
"Contact": "sample string 5"
}
],
"BirthGenderId": "sample string 1",
"EthnicityId": "sample string 2",
"LanguageId": "sample string 3",
"RaceId": "sample string 4",
"ReligionId": "sample string 5",
"MaritalStatusId": "sample string 6",
"Email": "sample string 7",
"NeedsInterpreter": true,
"EducationLevelId": "sample string 8",
"WrittenFormatId": "sample string 9",
"StudentStatusId": "sample string 10",
"CustomFields": [
{
"FieldId": "sample string 1",
"ResponseValue": "sample string 2"
},
{
"FieldId": "sample string 1",
"ResponseValue": "sample string 2"
}
],
"AlternativeNames": [
{
"NameTypeId": "sample string 1",
"LastName": "sample string 2",
"FirstName": "sample string 3",
"MiddleName": "sample string 4",
"Prefix": "sample string 5",
"Suffix": "sample string 6"
},
{
"NameTypeId": "sample string 1",
"LastName": "sample string 2",
"FirstName": "sample string 3",
"MiddleName": "sample string 4",
"Prefix": "sample string 5",
"Suffix": "sample string 6"
}
],
"PatientPortal": {
"ChallengeQuestionId": "sample string 1",
"ChallengeAnswer": "sample string 2",
"HealthInfoAccessOfferedId": "sample string 3"
}
}
},
"LoginId": "sample string 5",
"Password": "sample string 6",
"EmrInstance": "sample string 7",
"ApplicationName": "sample string 8",
"ApplicationKey": null,
"AuthorizationToken": "sample string 10",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
UdmPatientCreateResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| PatientId |
The identifier of the created patient. |
string |
None. |
| AlternativeIdentifiers |
The alternative identifiers of the created patient. |
Collection of Identity |
None. |
Response Codes
Http Status Code 201 - Indicates that the requested record was successfully created.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
{
"PatientId": "sample string 1",
"AlternativeIdentifiers": [
{
"Code": "sample string 1",
"Description": "sample string 2",
"Value": "sample string 3"
},
{
"Code": "sample string 1",
"Description": "sample string 2",
"Value": "sample string 3"
}
]
}