GET api/v1/{EMRSystem}/Patients/{PatientId}

Returns Patient demographic details for a given Patient Id. FHIR connectors use the following resources for R4: Patient.Read.

Status: Released

URI Parameters

NameDescriptionTypeAdditional information
EMRSystem

The emr system.

EMRSystem

None.
PatientId

The Patient ientifier.

string

Required
UserId

Gets or sets the user identifier.

string

Required
IncludeExtended

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

boolean

None.
IncludePCT

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

boolean

None.
IncludeIdentity

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

boolean

None.
IncludeRelatedPersons

Gets or sets a value indicating whether [include related persons].

boolean

None.
IncludeInsurancePlans

Gets or sets a value indicating whether [include insurance plans].

boolean

None.
IncludeComments

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

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

UdmPatientResponse
NameDescriptionTypeAdditional information
MRNIdentities

Gets or sets the MRN Identities.

Collection of MRNIdentity

None.
PatientCareTeams

Gets or sets the patient care teams.

Collection of PatientCareTeam

None.
Identities

Gets or sets the identities.

Collection of Identity

None.
RelatedPersons

Gets or sets the identities.

Collection of RelatedPersonRelationship

None.
InsurancePlans

Gets or sets the insurance plans.

Collection of InsurancePlan

None.
Comments

Gets or sets the List of Comments

Collection of Comment

None.
StudentStatus

Gets or sets the Student Status.

CodedObject

None.
WrittenFormat

Gets or sets the Written Format

CodedObject

None.
BirthGender

Gets or sets the Birth Gender

CodedObject

None.
PatientId

Gets or sets the patient identifier.

string

None.
DisplayName

Gets or sets the display name.

string

None.
LastName

Gets or sets the last name.

string

None.
FirstName

Gets or sets the first name.

string

None.
MiddleName

Gets or sets the name of the middle.

string

None.
Suffix

Gets or sets the suffix.

string

None.
Prefix

Gets or sets the prefix.

string

None.
BirthDateTime

Gets or sets the Date of Birth.

datetime

Date only
Gender

Gets or sets the gender.

CodedObject

None.
MRN

Gets or sets the MRN.

string

None.
Vip

Gets or sets the vip.

string

None.
Confidentiality

Gets or sets the confidentiality.

string

None.
DeceasedDateTime

Gets or sets the deceased date time.

datetime

Date only
SSN

Gets or sets the social security number.

string

None.
ExtendedInfo

Gets or sets the extended object.

ExtendedInfo

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

{
  "MRNIdentities": [
    {
      "Value": "sample string 1",
      "Type": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "SubType": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      }
    },
    {
      "Value": "sample string 1",
      "Type": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      },
      "SubType": {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "Description": "sample string 3"
      }
    }
  ],
  "PatientCareTeams": [
    {
      "NPI": "sample string 1",
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "RelationshipType": "sample string 2",
      "FromDate": "2025-12-12T20:50:10.2222984+00:00",
      "ToDate": "2025-12-12T20:50:10.2223971+00:00",
      "Phones": [
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "IsManuallyAdded": true,
      "InternalSequence": "sample string 4"
    },
    {
      "NPI": "sample string 1",
      "Provider": {
        "ProviderId": "sample string 1",
        "ProviderName": "sample string 2"
      },
      "RelationshipType": "sample string 2",
      "FromDate": "2025-12-12T20:50:10.2222984+00:00",
      "ToDate": "2025-12-12T20:50:10.2223971+00:00",
      "Phones": [
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "IsManuallyAdded": true,
      "InternalSequence": "sample string 4"
    }
  ],
  "Identities": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Value": "sample string 3"
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "Value": "sample string 3"
    }
  ],
  "RelatedPersons": [
    {
      "Person": {
        "PersonId": "sample string 1",
        "PersonName": "sample string 2"
      },
      "RelationshipType": "sample string 1",
      "FromDate": "2025-12-12T20:50:10.2252339+00:00",
      "ToDate": "2025-12-12T20:50:10.2252823+00:00",
      "ReltnTypeCD": "sample string 2",
      "PersonReltnDisp": "sample string 3",
      "PersonReltnCD": "sample string 4",
      "RelatedPersonReltnTypeDisp": "sample string 5",
      "RelatedPersonReltnTypeCD": "sample string 6",
      "ActiveStatusCD": "sample string 7",
      "ActiveStatusDisp": "sample string 8",
      "DataStatusCD": "sample string 9",
      "DataStatusDisp": "sample string 10",
      "Phones": [
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ]
    },
    {
      "Person": {
        "PersonId": "sample string 1",
        "PersonName": "sample string 2"
      },
      "RelationshipType": "sample string 1",
      "FromDate": "2025-12-12T20:50:10.2252339+00:00",
      "ToDate": "2025-12-12T20:50:10.2252823+00:00",
      "ReltnTypeCD": "sample string 2",
      "PersonReltnDisp": "sample string 3",
      "PersonReltnCD": "sample string 4",
      "RelatedPersonReltnTypeDisp": "sample string 5",
      "RelatedPersonReltnTypeCD": "sample string 6",
      "ActiveStatusCD": "sample string 7",
      "ActiveStatusDisp": "sample string 8",
      "DataStatusCD": "sample string 9",
      "DataStatusDisp": "sample string 10",
      "Phones": [
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ]
    }
  ],
  "InsurancePlans": [
    {
      "MemberId": "sample string 1",
      "PlanName": "sample string 2",
      "PlanDesc": "sample string 3",
      "GroupNumber": "sample string 4",
      "PayorName": "sample string 5",
      "PayorPhone": "sample string 6",
      "PayorState": "sample string 7",
      "PatientRelationToSubscriber": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "SubscriberRelationToPatient": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "SubscriberFirstName": "sample string 8",
      "SubscriberLastName": "sample string 9",
      "SubscriberBirthDate": "2025-12-12T20:50:10.2268107+00:00",
      "SubscriberAddress": {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.228443+00:00"
      },
      "SubscriberPhones": [
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "Priority": "sample string 10",
      "EffectiveFromDate": "2025-12-12T20:50:10.2289842+00:00",
      "EffectiveToDate": "2025-12-12T20:50:10.2290714+00:00",
      "InsuranceClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsuranceType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsurancePlanAddress": {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.228443+00:00"
      },
      "CustomFields": [
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "InsuranceId": "sample string 11",
      "HealthPlanId": "sample string 12",
      "SubscriberId": "sample string 13",
      "SubscriberMemberNumber": "sample string 14",
      "GroupName": "sample string 15",
      "IsActive": true,
      "ActiveStatusId": "sample string 17",
      "ActiveStatus": "sample string 18",
      "ActiveStatusPersonnelId": "sample string 19",
      "ActiveStatusDateTime": "2025-12-12T20:50:10.2303347+00:00",
      "DataStatusId": "sample string 20",
      "DataStatus": "sample string 21",
      "DataStatusPersonnelId": "sample string 22",
      "DataStatusDateTime": "2025-12-12T20:50:10.2304733+00:00",
      "InsuranceCardCopied": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EligibilityStatus": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsuranceCardNameFirst": "sample string 23",
      "InsuranceCardNameMiddle": "sample string 24",
      "InsuranceCardNameLast": "sample string 25",
      "InsuranceCardName": "sample string 26",
      "VerificationStatus": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "VerificationSource": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "VerificationPersonnelId": "sample string 27",
      "VerificationDateTime": "2025-12-12T20:50:10.230986+00:00",
      "AssignmentOfBenefits": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeductibleAmount": "sample string 28",
      "DeductibleRemaining": "sample string 29",
      "DeductibleIncludingMaxOutOfPocket": "sample string 30",
      "CopayAmount": "sample string 31",
      "CopayIncludingMaxOutOfPocket": "sample string 32",
      "MaxOutOfPocket": "sample string 33",
      "FamilyDeductibleMetAmount": "sample string 34"
    },
    {
      "MemberId": "sample string 1",
      "PlanName": "sample string 2",
      "PlanDesc": "sample string 3",
      "GroupNumber": "sample string 4",
      "PayorName": "sample string 5",
      "PayorPhone": "sample string 6",
      "PayorState": "sample string 7",
      "PatientRelationToSubscriber": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "SubscriberRelationToPatient": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "SubscriberFirstName": "sample string 8",
      "SubscriberLastName": "sample string 9",
      "SubscriberBirthDate": "2025-12-12T20:50:10.2268107+00:00",
      "SubscriberAddress": {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.228443+00:00"
      },
      "SubscriberPhones": [
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        },
        {
          "PhoneId": "sample string 1",
          "Number": "sample string 2",
          "SequenceNumber": "sample string 3",
          "Type": "sample string 4",
          "TypeId": "sample string 5",
          "Extension": "sample string 6",
          "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
          "Format": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          }
        }
      ],
      "Priority": "sample string 10",
      "EffectiveFromDate": "2025-12-12T20:50:10.2289842+00:00",
      "EffectiveToDate": "2025-12-12T20:50:10.2290714+00:00",
      "InsuranceClass": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsuranceType": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsurancePlanAddress": {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.228443+00:00"
      },
      "CustomFields": [
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        },
        {
          "Field": {
            "Id": "sample string 1",
            "Name": "sample string 2"
          },
          "CodedResponseValue": [
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            },
            {
              "Id": "sample string 1",
              "Name": "sample string 2"
            }
          ],
          "TextResponseValue": [
            "sample string 1",
            "sample string 2"
          ]
        }
      ],
      "InsuranceId": "sample string 11",
      "HealthPlanId": "sample string 12",
      "SubscriberId": "sample string 13",
      "SubscriberMemberNumber": "sample string 14",
      "GroupName": "sample string 15",
      "IsActive": true,
      "ActiveStatusId": "sample string 17",
      "ActiveStatus": "sample string 18",
      "ActiveStatusPersonnelId": "sample string 19",
      "ActiveStatusDateTime": "2025-12-12T20:50:10.2303347+00:00",
      "DataStatusId": "sample string 20",
      "DataStatus": "sample string 21",
      "DataStatusPersonnelId": "sample string 22",
      "DataStatusDateTime": "2025-12-12T20:50:10.2304733+00:00",
      "InsuranceCardCopied": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "EligibilityStatus": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "InsuranceCardNameFirst": "sample string 23",
      "InsuranceCardNameMiddle": "sample string 24",
      "InsuranceCardNameLast": "sample string 25",
      "InsuranceCardName": "sample string 26",
      "VerificationStatus": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "VerificationSource": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "VerificationPersonnelId": "sample string 27",
      "VerificationDateTime": "2025-12-12T20:50:10.230986+00:00",
      "AssignmentOfBenefits": {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      "DeductibleAmount": "sample string 28",
      "DeductibleRemaining": "sample string 29",
      "DeductibleIncludingMaxOutOfPocket": "sample string 30",
      "CopayAmount": "sample string 31",
      "CopayIncludingMaxOutOfPocket": "sample string 32",
      "MaxOutOfPocket": "sample string 33",
      "FamilyDeductibleMetAmount": "sample string 34"
    }
  ],
  "Comments": [
    {
      "CommentText": "sample string 1",
      "CommentUpdateDateTime": "2025-12-12T20:50:10.2326191+00:00",
      "CommentUpdatePersonnel": "2025-12-12",
      "InternalSequence": "sample string 2"
    },
    {
      "CommentText": "sample string 1",
      "CommentUpdateDateTime": "2025-12-12T20:50:10.2326191+00:00",
      "CommentUpdatePersonnel": "2025-12-12",
      "InternalSequence": "sample string 2"
    }
  ],
  "StudentStatus": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "WrittenFormat": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "BirthGender": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "PatientId": "sample string 1",
  "DisplayName": "sample string 2",
  "LastName": "sample string 3",
  "FirstName": "sample string 4",
  "MiddleName": "sample string 5",
  "Suffix": "sample string 6",
  "Prefix": "sample string 7",
  "BirthDateTime": "2025-12-12T20:50:10.233717+00:00",
  "Gender": {
    "Id": "sample string 1",
    "Name": "sample string 2"
  },
  "MRN": "sample string 8",
  "Vip": "sample string 9",
  "Confidentiality": "sample string 10",
  "DeceasedDateTime": "2025-12-12T20:50:10.2340732+00:00",
  "SSN": "sample string 11",
  "ExtendedInfo": {
    "Addresses": [
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.228443+00:00"
      },
      {
        "AddressId": "sample string 1",
        "Address1": "sample string 2",
        "Address2": "sample string 3",
        "Address3": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "ZIP": "sample string 7",
        "Type": "sample string 8",
        "TypeId": "sample string 9",
        "SequenceNumber": "sample string 10",
        "Country": "sample string 11",
        "County": "sample string 12",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.228443+00:00"
      }
    ],
    "Phones": [
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      },
      {
        "PhoneId": "sample string 1",
        "Number": "sample string 2",
        "SequenceNumber": "sample string 3",
        "Type": "sample string 4",
        "TypeId": "sample string 5",
        "Extension": "sample string 6",
        "EndEffectiveDateTime": "2025-12-12T20:50:10.222953+00:00",
        "Format": {
          "Id": "sample string 1",
          "Name": "sample string 2"
        }
      }
    ],
    "Ethnicity": "sample string 1",
    "Ethnicities": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Language": "sample string 2",
    "Race": "sample string 3",
    "Races": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2"
      }
    ],
    "Religion": "sample string 4",
    "MaritalStatus": "sample string 5",
    "Email": "sample string 6",
    "NeedsInterpreter": true,
    "PreferredPharmacies": [
      {
        "PharmacyId": "sample string 1",
        "PharmacyName": "sample string 2",
        "NCPDP": "sample string 3",
        "IsIntegratedRetail": true
      },
      {
        "PharmacyId": "sample string 1",
        "PharmacyName": "sample string 2",
        "NCPDP": "sample string 3",
        "IsIntegratedRetail": true
      }
    ],
    "GenderIdentity": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    },
    "BirthGender": {
      "Id": "sample string 1",
      "Name": "sample string 2"
    }
  }
}

'

GET api/v1/{EMRSystem}/Patients/{PatientId}

Returns Patient demographic details for a given Patient Id. FHIR connectors use the following resources for R4: Patient.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}}