GET Family Histories

GET api/v1/{EMRSystem}/FamilyHistories

Returns both active and inactive Family Histories for a patient along with family relationship data.

HTTP Method

GET

Applicable Emissary Products

Chart Retrieval
Analytics
Interactive

Allscripts

Released

Athena

Released

Cerner

Released

Epic

Released

Meditech

Released

Sandbox

Released

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 a collection of Family History Response View Models.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

FamilyHistoryId

Gets or sets the FamilyHistory identifier.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

FamilyHistoryDesc

Gets or sets the family history description.

string

None.

FamilyRelationshipType

Gets or sets the type of the family relationship.

string

None.

FamilyRelationshipName

Gets or sets the name of the family relationship.

string

None.

SNOMED

Gets or sets the snomed.

string

None.

AgeOfOnSet

Gets or sets the age of on set.

string

None.

AgeOfDeath

Gets or sets the age of death.

string

None.

Audits

Gets or sets the audits.

Collection of AuditViewModel

None.

PertinentNegative

Gets or sets a value indicating whether [pertinent negative].

boolean

None.

 
Response Codes

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

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
[
  {
    "FamilyHistoryId": "sample string 1",
    "PatientId": "sample string 2",
    "FamilyHistoryDesc": "sample string 3",
    "FamilyRelationshipType": "sample string 4",
    "FamilyRelationshipName": "sample string 5",
    "SNOMED": "sample string 6",
    "AgeOfOnSet": "sample string 7",
    "AgeOfDeath": "sample string 8",
    "Audits": [
      {
        "AuditDateTime": "2018-02-14T14:12:02.8496189Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      },
      {
        "AuditDateTime": "2018-02-14T14:12:02.8496189Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      }
    ],
    "PertinentNegative": true
  },
  {
    "FamilyHistoryId": "sample string 1",
    "PatientId": "sample string 2",
    "FamilyHistoryDesc": "sample string 3",
    "FamilyRelationshipType": "sample string 4",
    "FamilyRelationshipName": "sample string 5",
    "SNOMED": "sample string 6",
    "AgeOfOnSet": "sample string 7",
    "AgeOfDeath": "sample string 8",
    "Audits": [
      {
        "AuditDateTime": "2018-02-14T14:12:02.8496189Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      },
      {
        "AuditDateTime": "2018-02-14T14:12:02.8496189Z",
        "User": "sample string 1",
        "Action": "sample string 2",
        "Status": "sample string 3"
      }
    ],
    "PertinentNegative": true
  }
]
Sample Message
<ArrayOfFamilyHistoryViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
  <FamilyHistoryViewModel>
    <AgeOfDeath>sample string 8</AgeOfDeath>
    <AgeOfOnSet>sample string 7</AgeOfOnSet>
    <Audits>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-14T08:12:02.8496189-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-14T08:12:02.8496189-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
    </Audits>
    <FamilyHistoryDesc>sample string 3</FamilyHistoryDesc>
    <FamilyHistoryId>sample string 1</FamilyHistoryId>
    <FamilyRelationshipName>sample string 5</FamilyRelationshipName>
    <FamilyRelationshipType>sample string 4</FamilyRelationshipType>
    <PatientId>sample string 2</PatientId>
    <PertinentNegative>true</PertinentNegative>
    <SNOMED>sample string 6</SNOMED>
  </FamilyHistoryViewModel>
  <FamilyHistoryViewModel>
    <AgeOfDeath>sample string 8</AgeOfDeath>
    <AgeOfOnSet>sample string 7</AgeOfOnSet>
    <Audits>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-14T08:12:02.8496189-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
      <AuditViewModel>
        <Action>sample string 2</Action>
        <AuditDateTime>2018-02-14T08:12:02.8496189-06:00</AuditDateTime>
        <Status>sample string 3</Status>
        <User>sample string 1</User>
      </AuditViewModel>
    </Audits>
    <FamilyHistoryDesc>sample string 3</FamilyHistoryDesc>
    <FamilyHistoryId>sample string 1</FamilyHistoryId>
    <FamilyRelationshipName>sample string 5</FamilyRelationshipName>
    <FamilyRelationshipType>sample string 4</FamilyRelationshipType>
    <PatientId>sample string 2</PatientId>
    <PertinentNegative>true</PertinentNegative>
    <SNOMED>sample string 6</SNOMED>
  </FamilyHistoryViewModel>
</ArrayOfFamilyHistoryViewModel>

Submit a Comment

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

 

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