GET Social Histories

Developer Tools

GET api/v1/{EMRSystem}/SocialHistories

Returns both active and inactive Social Histories for a patient along with summary of Social History details.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Clinical Analytics
Interactive Workflow

Allscripts

Released

Athena

Released

Cerner

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

Gets or sets the user identifier.

string

Required

PatientId

Gets or sets the patient identifier.

string

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing SocialHistory Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

SocialHistoryId

Gets or sets the SocialHistory identifier.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

SocialHistoryLabel

Gets or sets the social history label.

string

None.

SocialHistoryDesc

Gets or sets the social history desc.

string

None.

LastReviewedDateTime

Gets or sets the last reviewed date time.

date

None.

Audits

Gets or sets the audits.

Collection of AuditViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.SocialHistoryResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

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

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
Sample Message
Download Json Schema
[
  {
    "SocialHistoryId": "sample string 1",
    "PatientId": "sample string 2",
    "SocialHistoryLabel": "sample string 3",
    "SocialHistoryDesc": "sample string 4",
    "LastReviewedDateTime": "2018-02-15T17:13:19.4975419Z",
    "Audits": [
      {
        "AuditDateTime": "2018-02-15T17:13:19.4975419Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      },
      {
        "AuditDateTime": "2018-02-15T17:13:19.4975419Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      }
    ]
  },
  {
    "SocialHistoryId": "sample string 1",
    "PatientId": "sample string 2",
    "SocialHistoryLabel": "sample string 3",
    "SocialHistoryDesc": "sample string 4",
    "LastReviewedDateTime": "2018-02-15T17:13:19.4975419Z",
    "Audits": [
      {
        "AuditDateTime": "2018-02-15T17:13:19.4975419Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      },
      {
        "AuditDateTime": "2018-02-15T17:13:19.4975419Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      }
    ]
  }
]
Sample Message
<ArrayOfSocialHistoryViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <SocialHistoryViewModel>
    <Audits>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-15T11:13:19.4975419-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-15T11:13:19.4975419-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
    </Audits>
    <LastReviewedDateTime>2018-02-15T11:13:19.4975419-06:00</LastReviewedDateTime>
    <PatientId>sample string 2</PatientId>
    <SocialHistoryDesc>sample string 4</SocialHistoryDesc>
    <SocialHistoryId>sample string 1</SocialHistoryId>
    <SocialHistoryLabel>sample string 3</SocialHistoryLabel>
  </SocialHistoryViewModel>
  <SocialHistoryViewModel>
    <Audits>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-15T11:13:19.4975419-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-15T11:13:19.4975419-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
    </Audits>
    <LastReviewedDateTime>2018-02-15T11:13:19.4975419-06:00</LastReviewedDateTime>
    <PatientId>sample string 2</PatientId>
    <SocialHistoryDesc>sample string 4</SocialHistoryDesc>
    <SocialHistoryId>sample string 1</SocialHistoryId>
    <SocialHistoryLabel>sample string 3</SocialHistoryLabel>
  </SocialHistoryViewModel>
</ArrayOfSocialHistoryViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?