GET api/v1/{EMRSystem}/Documents/{DocumentId}

Returns details of a Document or clinical note. FHIR connectors use the following resources for R4: DocumentReference.Read, Patient.Read, Practitioner.Read, Encounter.Read, and Binary.Read.

Status: Released

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

None.
UserId

Gets or sets the user identifier.

string

Required
DocumentId

The document identifier.

string

Required
IncludeBody

Gets or sets a value indicating whether [include body].

boolean

None.

Header Parameters

NameDescriptionTypeAdditional 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.

Response Information

UdmDocumentResponse
NameDescriptionTypeAdditional information
DocumentAudits

Gets or sets the document audits.

Collection of DocumentAudit

None.
Documents

Gets or sets the children document.

Collection of ChildDocument

None.
DocumentNotes

Gets or sets the document notes.

Collection of Note

None.
DocumentId

Gets or sets the document identifier.

string

None.
DocumentDateTime

Gets or sets the document date time.

datetime

None.
LastUpdateDateTime

Gets or sets the document last update date time.

datetime

None.
DocumentResultDateTime

Gets or sets the document result date time.

datetime

None.
DocumentTitle

Gets or sets the document title.

string

None.
DocumentType

Gets or sets the document type.

string

None.
DocumentTypeId

Gets or sets the document type Id.

string

None.
DocumentStatus

Gets or sets the document status.

string

None.
PatientId

Gets or sets the patient identifier.

string

None.
EncounterId

Gets or sets the encounter identifier.

string

None.
EncounterType

Gets or sets the encounter type.

CodedObject

None.
PatientClass

Gets or sets the patient class.

CodedObject

None.
OrderId

Gets or sets the order identifier.

string

None.
ActiveInd

Gets or sets a value indicating whether [active ind].

boolean

None.
AuthorName

Gets or sets the name of the author.

string

None.
DocumentFormat

Gets or sets the document format.

string

None.

Response Codes

Http Status Code 200 - Indicates that the request was processed successfully.

Http Status Code 404 - Indicates that the resource to get could not be found.

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

{
  "DocumentAudits": [
    {
      "ActionType": "sample string 1",
      "ActionDateTime": "2025-12-12T20:56:31.3295689+00:00",
      "ActionStatus": "sample string 2",
      "ActionPractitioner": "sample string 3",
      "ActionPractitionerId": "sample string 4"
    },
    {
      "ActionType": "sample string 1",
      "ActionDateTime": "2025-12-12T20:56:31.3295689+00:00",
      "ActionStatus": "sample string 2",
      "ActionPractitioner": "sample string 3",
      "ActionPractitionerId": "sample string 4"
    }
  ],
  "Documents": [
    {
      "DocumentId": "sample string 1",
      "DocumentDateTime": "2025-12-12T20:56:31.3443521+00:00",
      "DocumentTitle": "sample string 2",
      "DocumentType": "sample string 3",
      "DocumentStatus": "sample string 4",
      "DocumentPointer": "sample string 5",
      "ActiveInd": true,
      "Storage": "sample string 6",
      "Format": "sample string 7",
      "Body": "sample string 8",
      "BodyLength": "sample string 9",
      "IsEncoded": true
    },
    {
      "DocumentId": "sample string 1",
      "DocumentDateTime": "2025-12-12T20:56:31.3443521+00:00",
      "DocumentTitle": "sample string 2",
      "DocumentType": "sample string 3",
      "DocumentStatus": "sample string 4",
      "DocumentPointer": "sample string 5",
      "ActiveInd": true,
      "Storage": "sample string 6",
      "Format": "sample string 7",
      "Body": "sample string 8",
      "BodyLength": "sample string 9",
      "IsEncoded": true
    }
  ],
  "DocumentNotes": [
    {
      "Comments": "sample string 1",
      "NoteDateTime": "2025-12-12T20:56:31.3645521+00:00",
      "Format": "sample string 2",
      "IsEncoded": true,
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "NoteType": "sample string 4"
    },
    {
      "Comments": "sample string 1",
      "NoteDateTime": "2025-12-12T20:56:31.3645521+00:00",
      "Format": "sample string 2",
      "IsEncoded": true,
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "NoteType": "sample string 4"
    }
  ],
  "DocumentId": "sample string 1",
  "DocumentDateTime": "2025-12-12T20:56:31.3748959+00:00",
  "LastUpdateDateTime": "2025-12-12T20:56:31.3749862+00:00",
  "DocumentResultDateTime": "2025-12-12T20:56:31.3825857+00:00",
  "DocumentTitle": "sample string 2",
  "DocumentType": "sample string 3",
  "DocumentTypeId": "sample string 4",
  "DocumentStatus": "sample string 5",
  "PatientId": "sample string 6",
  "EncounterId": "sample string 7",
  "EncounterType": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PatientClass": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "OrderId": "sample string 8",
  "ActiveInd": true,
  "AuthorName": "sample string 9",
  "DocumentFormat": "sample string 10"
}

'

GET api/v1/{EMRSystem}/Documents/{DocumentId}

Returns details of a Document or clinical note. FHIR connectors use the following resources for R4: DocumentReference.Read, Patient.Read, Practitioner.Read, Encounter.Read, and Binary.Read.

Status: Released

URI Parameters


Required
Required

Header Parameters

Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Data type: Password , Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox
Required if using application keys
Data type: Password , Required if using application keys

Request: {{ method }} {{ url }}

  • Http Request Headers
  • {{header.name}} : {{header.value}} ******
  • Http Request Body
  • {{httpRequestBody}}
  • Http Response Headers
  • {{header.name}} : {{header.value}} ******
  • Http Response Data
  • {{httpResponseData}}