| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Gets or sets the user identifier. |
string |
Required |
| PatientId |
Gets or sets the patient identifier. |
string |
Required |
| PatientIdType |
Sets patient Id Type such as MRN, FIN, etc. This is a reference Id. |
string |
None. |
| EncounterId |
Gets or sets the encounter identifier. |
string |
Required if EMRSystem = Epic, or CernerFHIR |
| EncounterAlias |
Gets or sets the encounter alias. |
string |
None. |
| DocumentType |
Gets or sets the document type. |
string |
Required |
| DocumentDateTime |
Gets or sets the document date/time. |
datetime |
Required if EMRSystem = Allscripts, or Cerner, or CernerFHIR, or Athena, or Meditech, or TouchWorksUnity |
| Status |
Gets or sets the document staus. |
string |
Required |
| Description |
Gets or sets the document description. |
string |
None. |
| Format |
Gets or sets the document format. |
string |
Required |
| Body |
Gets or sets the document body. |
string |
Required |
| AuthorUserId |
User identifier of the author of the document if different than the UserId |
string |
None. |
| CosignerUserId |
User identifier of the requested cosigner of the document |
string |
None. |
| ServiceDepartmentId |
Identifier of the service (Epic) or department (Meditech) of the document. |
string |
Required if EMRSystem = Meditech |
| DictationDateTime |
Date/time the document was dictated |
datetime |
None. |
| TranscriptionDateTime |
Date/time the document was transcribed |
datetime |
None. |
| ExternalDocumentId |
Sets the external document id |
string |
None. |
| 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. |
| EMRSystem |
The emr system. |
EMRSystem |
None. |