NAV
Ruby Shell

Patient API v1

A patient in Oracle Health Data Intelligence represents the demographic information necessary to identify an individual person in the context of a given population. A person in real life may be represented as multiple patients in multiple populations across one or more tenants.

Note: The data retrieved by this API is filtered based on your sensitive data filters for Health Data Intelligence. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from Health Data Intelligence into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in Oracle Health Data Intelligence in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us-1.healtheintent.com/patient/v1

patient-search

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-search', headers: headers, body: {"name":"John Doe","alias":{"system":"1.2.3.4.5.6.7.8.9.10.1","value":"151579"},"birthDate":"1911-01-25","telecom":"(010)111-1234"}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-search \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"John Doe","alias":{"system":"1.2.3.4.5.6.7.8.9.10.1","value":"151579"},"birthDate":"1911-01-25","telecom":"(010)111-1234"}

Example response

{
  "items": [
    {
      "id": {
        "id": "a2f6a16d-1331-4ccc-8f70-6c4d953b1234"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-search?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-search?offset=0&limit=20"
}

POST /populations/{populationId}/patient-search

Retrieves a list of patient ids.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path integer(int32) true N/A No description -
body body postPopulationsPopulationidPatientSearch true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK OK SearchResults
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error

Patient Demographics

The Patient Demographics endpoint allows you to retrieve demographic information for a given patient in the population.

Retrieve a Single Demographic Record

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/demographics/c2daa46ed913ee115d42cd6ba7d76272c15d2fef6b206008f9cec46c94eea277', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/demographics/c2daa46ed913ee115d42cd6ba7d76272c15d2fef6b206008f9cec46c94eea277 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "c2daa46ed913ee115d42cd6ba7d76272c15d2fef6b206008f9cec46c94eea277",
  "sourceIdentifier": {
    "dataPartitionId": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
    "id": "151579"
  },
  "birthDate": "1980-08-02",
  "birthDateTime": "1980-08-02T06:00:00.000",
  "gender": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:57",
        "code": "362",
        "display": "Female"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "248152002",
        "display": "Female"
      }
    ],
    "text": "Female"
  },
  "languages": [
    {
      "sourceCodings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "297487008",
          "display": "English language"
        }
      ],
      "codings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "297487008",
          "display": "English language"
        }
      ],
      "text": "English language"
    }
  ],
  "maritalStatus": {
    "sourceCodings": [
      {
        "system": "urn:cerner:coding:codingsystem:codeset:38",
        "code": "309236",
        "display": "Divorced"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.12.2",
        "code": "D",
        "display": "Divorced"
      }
    ],
    "text": "Divorced"
  },
  "races": [
    {
      "sourceCodings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "14045001",
          "display": "Caucasian"
        }
      ],
      "codings": [
        {
          "system": "2.16.840.1.113883.6.96",
          "code": "14045001",
          "display": "Caucasian"
        }
      ],
      "text": "Caucasian"
    }
  ],
  "ethnicities": [
    {
      "sourceCodings": [
        {
          "system": "urn:cerner:coding:codingsystem:codeset:27",
          "code": "312507",
          "display": "Non-Hispanic"
        }
      ],
      "codings": [
        {
          "system": "2.16.840.1.113883.5.50",
          "code": "2186-5",
          "display": "Not Hispanic or Latino"
        }
      ],
      "text": "Non-Hispanic"
    }
  ],
  "dateOfDeath": "2018-08-23",
  "deceased": true,
  "causeOfDeath": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.90",
        "code": "V45",
        "display": "Car occupant injured in collision with railway train or railway vehicle"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.90",
        "code": "V45",
        "display": "Car occupant injured in collision with railway train or railway vehicle"
      }
    ],
    "text": "Car occupant injured in collision with railway train or railway vehicle"
  },
  "names": [
    {
      "use": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.12.200",
            "code": "B",
            "display": "Birth Name"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.200",
            "code": "B",
            "display": "Birth Name"
          }
        ],
        "text": "Birth Name"
      },
      "formatted": "Ms Analisa Roberson",
      "givenNames": [
        "Analisa",
        "Elizabeth"
      ],
      "familyNames": [
        "Roberson"
      ],
      "prefix": "Ms",
      "effectivePeriod": {
        "start": "1980-08-02",
        "end": "2018-08-23"
      }
    }
  ],
  "aliases": [
    {
      "value": "151579",
      "computationalValue": "1831176692",
      "renderedValue": "1831-176692",
      "system": "1.2.3.4.5.6.7.8.9.10.1",
      "type": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.12.203",
            "code": "MR",
            "display": "Medical record number"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.203",
            "code": "MR",
            "display": "Medical record number"
          }
        ],
        "text": "Medical record number"
      }
    }
  ],
  "addresses": [
    {
      "use": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.12.190",
            "code": "H",
            "display": "Home"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.190",
            "code": "H",
            "display": "Home"
          }
        ],
        "text": "Home"
      },
      "lines": [
        "1924 Schiller Plains",
        "Apartment 19"
      ],
      "city": "Los Angeles",
      "state": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.92",
            "code": "CA",
            "display": "California"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.92",
            "code": "CA",
            "display": "California"
          }
        ],
        "text": "California"
      },
      "postalCode": "90717",
      "country": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:15",
            "code": "309221",
            "display": "US"
          }
        ],
        "text": "US"
      },
      "effectivePeriod": {
        "start": "1980-08-02",
        "end": "1990-08-20"
      }
    }
  ],
  "telecoms": [
    {
      "use": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:43",
            "code": "170",
            "display": "Home"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.5.1012",
            "code": "HP",
            "display": "primary home"
          }
        ],
        "text": "Home"
      },
      "value": "555-203-1314",
      "countryCode": "001",
      "effectivePeriod": {
        "start": "2000-01-01",
        "end": "2018-08-23"
      }
    }
  ],
  "birthSex": {
    "sourceCodings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "248152002",
        "display": "F"
      }
    ],
    "codings": [
      {
        "system": "2.16.840.1.113883.6.96",
        "code": "248152002",
        "display": "Female"
      }
    ],
    "text": "Female"
  }
}

GET /populations/{populationId}/patients/{patientId}/demographics/{id}

Retrieves a single demographic record for a given patient.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
patientId path string true N/A The unique ID of a patient in a population. -
id path string true N/A The unique ID of the demographic record for the patient. -

Response Statuses

Status Meaning Description Schema
200 OK OK PatientPublicApi_V1_Entities_Demographic
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Retrieve a List of Demographic Records

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/demographics', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/demographics \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "c2daa46ed913ee115d42cd6ba7d76272c15d2fef6b206008f9cec46c94eea277",
      "sourceIdentifier": {
        "dataPartitionId": "877307a0-b5f5-4a01-9d4b-9fead6bcf788",
        "id": "151579"
      },
      "birthDate": "1980-08-02",
      "birthDateTime": "1980-08-02T06:00:00.000",
      "gender": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:57",
            "code": "362",
            "display": "Female"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "248152002",
            "display": "Female"
          }
        ],
        "text": "Female"
      },
      "languages": [
        {
          "sourceCodings": [
            {
              "system": "2.16.840.1.113883.6.96",
              "code": "297487008",
              "display": "English language"
            }
          ],
          "codings": [
            {
              "system": "2.16.840.1.113883.6.96",
              "code": "297487008",
              "display": "English language"
            }
          ],
          "text": "English language"
        }
      ],
      "maritalStatus": {
        "sourceCodings": [
          {
            "system": "urn:cerner:coding:codingsystem:codeset:38",
            "code": "309236",
            "display": "Divorced"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.12.2",
            "code": "D",
            "display": "Divorced"
          }
        ],
        "text": "Divorced"
      },
      "races": [
        {
          "sourceCodings": [
            {
              "system": "2.16.840.1.113883.6.96",
              "code": "14045001",
              "display": "Caucasian"
            }
          ],
          "codings": [
            {
              "system": "2.16.840.1.113883.6.96",
              "code": "14045001",
              "display": "Caucasian"
            }
          ],
          "text": "Caucasian"
        }
      ],
      "ethnicities": [
        {
          "sourceCodings": [
            {
              "system": "urn:cerner:coding:codingsystem:codeset:27",
              "code": "312507",
              "display": "Non-Hispanic"
            }
          ],
          "codings": [
            {
              "system": "2.16.840.1.113883.5.50",
              "code": "2186-5",
              "display": "Not Hispanic or Latino"
            }
          ],
          "text": "Non-Hispanic"
        }
      ],
      "dateOfDeath": "2018-08-23",
      "deceased": true,
      "causeOfDeath": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.90",
            "code": "V45",
            "display": "Car occupant injured in collision with railway train or railway vehicle"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.90",
            "code": "V45",
            "display": "Car occupant injured in collision with railway train or railway vehicle"
          }
        ],
        "text": "Car occupant injured in collision with railway train or railway vehicle"
      },
      "names": [
        {
          "use": {
            "sourceCodings": [
              {
                "system": "2.16.840.1.113883.12.200",
                "code": "B",
                "display": "Birth Name"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.200",
                "code": "B",
                "display": "Birth Name"
              }
            ],
            "text": "Birth Name"
          },
          "formatted": "Ms Analisa Roberson",
          "givenNames": [
            "Analisa",
            "Elizabeth"
          ],
          "familyNames": [
            "Roberson"
          ],
          "prefix": "Ms",
          "effectivePeriod": {
            "start": "1980-08-02",
            "end": "2018-08-23"
          }
        }
      ],
      "aliases": [
        {
          "value": "151579",
          "computationalValue": "1831176692",
          "renderedValue": "1831-176692",
          "system": "1.2.3.4.5.6.7.8.9.10.1",
          "type": {
            "sourceCodings": [
              {
                "system": "2.16.840.1.113883.12.203",
                "code": "MR",
                "display": "Medical record number"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.203",
                "code": "MR",
                "display": "Medical record number"
              }
            ],
            "text": "Medical record number"
          }
        }
      ],
      "addresses": [
        {
          "use": {
            "sourceCodings": [
              {
                "system": "2.16.840.1.113883.12.190",
                "code": "H",
                "display": "Home"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.12.190",
                "code": "H",
                "display": "Home"
              }
            ],
            "text": "Home"
          },
          "lines": [
            "1924 Schiller Plains",
            "Apartment 19"
          ],
          "city": "Los Angeles",
          "state": {
            "sourceCodings": [
              {
                "system": "2.16.840.1.113883.6.92",
                "code": "CA",
                "display": "California"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.6.92",
                "code": "CA",
                "display": "California"
              }
            ],
            "text": "California"
          },
          "postalCode": "90717",
          "country": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:15",
                "code": "309221",
                "display": "US"
              }
            ],
            "text": "US"
          },
          "effectivePeriod": {
            "start": "1980-08-02",
            "end": "1990-08-20"
          }
        }
      ],
      "telecoms": [
        {
          "use": {
            "sourceCodings": [
              {
                "system": "urn:cerner:coding:codingsystem:codeset:43",
                "code": "170",
                "display": "Home"
              }
            ],
            "codings": [
              {
                "system": "2.16.840.1.113883.5.1012",
                "code": "HP",
                "display": "primary home"
              }
            ],
            "text": "Home"
          },
          "value": "555-203-1314",
          "countryCode": "001",
          "effectivePeriod": {
            "start": "2000-01-01",
            "end": "2018-08-23"
          }
        }
      ],
      "birthSex": {
        "sourceCodings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "248152002",
            "display": "F"
          }
        ],
        "codings": [
          {
            "system": "2.16.840.1.113883.6.96",
            "code": "248152002",
            "display": "Female"
          }
        ],
        "text": "Female"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/demographics?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patients/a2f6a16d-1331-4ccc-8f70-6c4d953ba70b/demographics?offset=0&limit=20"
}

GET /populations/{populationId}/patients/{patientId}/demographics

Retrieves a list of demographic records for a patient.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
patientId path string true N/A The unique ID of a patient in a population. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

Response Statuses

Status Meaning Description Schema
200 OK OK Demographics
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Health Data Intelligence Patient ID Lookup

The Patient ID Lookup endpoint allows you to retrieve a list of Health Data Intelligence patient IDs using a local source person ID and data partition ID. Because Health Data Intelligence collects data from many different sources, the Health Data Intelligence patient ID is used to identify patients and consolidate their information in Health Data Intelligence. Retrieving the Health Data Intelligence patient ID is the first step to sending many requests to the Health Data Intelligence APIs.

Health Data Intelligence Patient ID Lookup

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-id-lookup',
  query: {
  'dataPartitionId' => 'string',
'sourcePersonId' => 'array[string]'
}, headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-id-lookup?dataPartitionId=type,string&type=array&items=%5Bobject%20Object%5D \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "sourcePersonId": "3019123",
      "patient": {
        "id": "a2f6a16d-1331-4ccc-8f70-6c4d953b1234"
      }
    },
    {
      "sourcePersonId": "1597456",
      "patient": {
        "id": "b3g6a16d-1331-4ccc-8f70-6c4d953b8765"
      }
    },
    {
      "sourcePersonId": "1234566",
      "patient": {
        "id": "c4e6a16d-1331-4ccc-8f70-6c4d95323456"
      }
    }
  ]
}

GET /populations/{populationId}/patient-id-lookup

Retrieves the Health Data Intelligence patient IDs for a given patient using the local source person IDs and data partition IDs. You can specify up to 100 local source person IDs in a single request.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
dataPartitionId query string true N/A The ID of the source data partition. -
sourcePersonId query array[string] true N/A The ID of the person in the source data partition. A single request can be sent for between 1 and 100 IDs. -

Response Statuses

Status Meaning Description Schema
200 OK OK PatientPublicApi_V1_Entities_IdLookupResultList
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Health Data Intelligence Patient ID Lookup By Alias

The Patient ID Lookup By Alias endpoint allows you to retrieve a list of Health Data Intelligence patient IDs for the requested list of aliases. Because Health Data Intelligence collects data from many different sources, the Health Data Intelligence patient ID is used to identify patients and consolidate their information in Health Data Intelligence. Retrieving the Health Data Intelligence patient ID is the first step to sending many requests to the Health Data Intelligence APIs.

Health Data Intelligence Patient ID Lookup By Alias

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-id-lookup-by-alias',
  query: {
  'alias' => 'array[string]'
}, headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/patient/v1/populations/1424e81d-8cea-4d6b-b140-d6630b684a58/patient-id-lookup-by-alias?type=array&items=%5Bobject%20Object%5D \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "patient": {
        "id": "a2f6a16d-1331-4ccc-8f70-6c4d953b1234"
      }
    },
    {
      "patient": {
        "id": "b3g6a16d-1331-4ccc-8f70-6c4d953b8765"
      }
    },
    {
      "patient": {
        "id": "c4e6a16d-1331-4ccc-8f70-6c4d95323456"
      }
    }
  ]
}

GET /populations/{populationId}/patient-id-lookup-by-alias

Look up the Health Data Intelligence patient ID for one or more aliases associated with a specific patient, such as the patient’s driver’s license number and medical record number (MRN). The requested aliases are presumed to be associated to a single patient ID. In specific cases, however, it is possible to have multiple patient IDs returned in the response, for example, when the alias type is not globally unique or Master Person Management has not resolved different systems’ disagreement about the alias-patient relationship. The Patient Demographics endpoint can be used to retrieve further demographics information for the returned patients. You can specify up to 100 aliases in a single request.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId path string true N/A The ID of the population. -
alias query array[string] true N/A A list of IDs for the patient that are intended to facilitate interoperability among systems. Aliases, such as an MRN or Social Security number (SSN), are commonly used to uniquely identify the individual. An alias consists of the system and value concatenated together with a vertical bar (|). To ensure the correct identification of an alias, the value and system must be an exact match. If a vertical bar occurs in either the system or value, it must be escaped using an escape character (\), for example, system\|withVerticalBar|value. If an escape character occurs in either the system or value, it must also be escaped using an escape character, for example, system\\withEscape|value. -

Response Statuses

Status Meaning Description Schema
200 OK OK PatientPublicApi_V1_Entities_IdLookupByAliasResultList
400 Bad Request Bad Request HealtheintentApi_Common_Models_Error
401 Unauthorized Unauthorized HealtheintentApi_Common_Models_Error
403 Forbidden Forbidden HealtheintentApi_Common_Models_Error
404 Not Found Not Found HealtheintentApi_Common_Models_Error

Schema Definitions

PatientPublicApi_V1_Entities_IdLookupResult

Name Type Required Description Accepted Values
sourcePersonId string true The ID of the patient in the source data partition. -
patient PatientPublicApi_V1_Entities_PatientReference true A reference to the matching patient. -

PatientPublicApi_V1_Entities_PatientReference

Name Type Required Description Accepted Values
id string true The Health Data Intelligence patient ID. -

PatientPublicApi_V1_Entities_IdLookupResultList

Name Type Required Description Accepted Values
items [PatientPublicApi_V1_Entities_IdLookupResult] true A list of patient IDs. -

PatientPublicApi_V1_Entities_IdLookupByAliasResult

Name Type Required Description Accepted Values
patient PatientPublicApi_V1_Entities_PatientReference true A reference to the matching patient. -

PatientPublicApi_V1_Entities_IdLookupByAliasResultList

Name Type Required Description Accepted Values
items [PatientPublicApi_V1_Entities_IdLookupByAliasResult] true A list of patient IDs. -

PatientPublicApi_V1_Entities_Demographic

Name Type Required Description Accepted Values
id string true An ID that uniquely identifies the demographic record in the context of the patient. -
sourceIdentifier HealtheintentApi_Common_Models_SourceIdentifier true An ID that uniquely identifies this demographic record for a patient in a data partition. -
birthDate string false The date of birth of the patient. In International Organization for Standardization (ISO) 8601 formatting with precision ranging from YYYY to YYYY-MM-DD. The date of birth does not designate a time zone. -
birthDateTime string false The time of birth of the patient. In ISO 8601 formatting with precision ranging from YYYY-MM-DDThh to YYYY-MM-DDThh:mm:ss.SSS. The birth date time does not designate a time zone. -
gender HealtheintentApi_Common_Models_CodeableConcept false The administrative gender code of the patient. The administrative gender can differ from the patient’s clinical sex, preferred gender identity, legal sex, and birth sex. -
languages [HealtheintentApi_Common_Models_CodeableConcept] true A list of languages that a patient can use to communicate. -
maritalStatus HealtheintentApi_Common_Models_CodeableConcept false The marital (civil) status of the patient indicating the patient’s relationship to a significant other. -
races [HealtheintentApi_Common_Models_CodeableConcept] true A list of races pertaining to the patient. In the U.S., the constructs of race and ethnicity are largely based on sociopolitical established practice and self-identification as opposed to anthropological or scientific classification. -
ethnicities [HealtheintentApi_Common_Models_CodeableConcept] true A list of ethnicities pertaining to the patient. In the U.S., the constructs of race and ethnicity are largely based on sociopolitical established practice and self-identification as opposed to anthropological or scientific classification. -
dateOfDeath string false The date and time of the patient’s death. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
deceased boolean false Indicates whether a patient is deceased. -
causeOfDeath HealtheintentApi_Common_Models_CodeableConcept false The specific medical event that led to the death of the patient, including specific injuries, illnesses, and other similar information. -
names [PatientPublicApi_V1_Entities_Name] true The names of the patient. The list may include previous names such as the maiden name. -
aliases [PatientPublicApi_V1_Entities_Alias] true A list of IDs for the patient that are intended to facilitate interoperability among systems and commonly and uniquely identify the individual. Aliases are distinguished from source IDs that have meaning only in the context of the source system. -
addresses [PatientPublicApi_V1_Entities_Address] true A list of addresses for the patient. This list may include multiple current (for example, work and multiple home addresses) and previous addresses. -
telecoms [PatientPublicApi_V1_Entities_Telecom] true A list of contact details for a patient. These contact details may include current or previous email addresses and contact numbers. -
birthSex HealtheintentApi_Common_Models_CodeableConcept false The sex the patient was assigned at birth as documented on the birth registration. -

HealtheintentApi_Common_Models_SourceIdentifier

Name Type Required Description Accepted Values
dataPartitionId string false The ID of the data partition. See the Data Partitions endpoint of the Data Source API for more information. -
id string false An ID that uniquely identifies this entity for a patient in the data partition. -

HealtheintentApi_Common_Models_CodeableConcept

Name Type Required Description Accepted Values
codings [HealtheintentApi_Common_Models_Code] true A list of codified values from standard code systems recognized by Health Data Intelligence. -
sourceCodings [HealtheintentApi_Common_Models_Code] true The list of codified values provided in the source data. Not all of these codes are available in the codings list. For example, local or proprietary codes are not included on the codings list because they are not recognized by Health Data Intelligence. -
text string false This may be a localized or annotated description of the element provided by a source system or display text associated with one of the codes on the codings or sourceCodings list. -

HealtheintentApi_Common_Models_Code

Name Type Required Description Accepted Values
code string true The unique ID of the code. -
display string false A human-readable representation of the code. -
system string true The ID of the coding system that gives meaning to the code. -

PatientPublicApi_V1_Entities_Name

Name Type Required Description Accepted Values
use HealtheintentApi_Common_Models_CodeableConcept false The purpose of the name, for example, Maiden or Phonetic. -
formatted string false The name formatted as the source indicates it should be displayed. -
givenNames [string] true An ordered list of given names (first and middle names). -
familyNames [string] true An ordered list of family names. -
prefix string false The parts that come before the name such as Dr., Mr., or Mrs. -
suffix string false The parts that come after the name such as MD, III, or Jr. -
effectivePeriod PatientPublicApi_V1_Entities_Period false The period of time when the name is valid for the patient. -

PatientPublicApi_V1_Entities_Period

Name Type Required Description Accepted Values
start string false The start date of the period. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -
end string false The end date of the period. If start exists without end, then this indicates that the period is ongoing. In ISO 8601 formatting with precision ranging from YYYY to YYYY-MM-DDThh:mm:ss.SSSZ. -

PatientPublicApi_V1_Entities_Alias

Name Type Required Description Accepted Values
value string true The ID issued by the assigning authority. The formatting may vary by source or alias type. -
computationalValue string false The formatted version of the alias value that is unique in the system and can be used for computational mapping (for example, removing nonsignificant whitespace, dashes, and so on). -
renderedValue string false The rendered version of the alias value intended for human display. For example, a sensitive ID (such as a Social Security number (SSN)) partially obscured by asterisks or a driver’s license number with dashes inserted. -
system string true The authority responsible for assigning the alias value. Alias values may be unique in each system but not across systems. For example, an MRN with a value of 12345 in one hospital’s system may represent a different person than MRN 12345 in a different hospital’s system. Health Data Intelligence avoids identity collisions by indicating the authority that assigned the alias. Ignoring the assigning authority presents security and data integrity concerns, for example, data being associated with the wrong patient or record. -
type HealtheintentApi_Common_Models_CodeableConcept false The type of the alias, for example, medical record number (MRN) or National Health Service (NHS). -

PatientPublicApi_V1_Entities_Address

Name Type Required Description Accepted Values
use HealtheintentApi_Common_Models_CodeableConcept false The purpose of the address, for example, Home or Work. -
lines [string] true An ordered list of address lines indicating the house number, apartment number, street name, street direction, P.O. Box number, and similar address information. -
city string false The name of the city, town, or village. -
state HealtheintentApi_Common_Models_CodeableConcept false The state or other subunit of a country. -
postalCode string false The region defined by the postal service for this address. -
country HealtheintentApi_Common_Models_CodeableConcept false The nation specified for this address. -
effectivePeriod PatientPublicApi_V1_Entities_Period false The period of time when this address is valid for the patient. -

PatientPublicApi_V1_Entities_Telecom

Name Type Required Description Accepted Values
use HealtheintentApi_Common_Models_CodeableConcept false The purpose of the telecom, for example, Home or Work. -
systemCategory string false The type of communication medium. EMAIL, Note: For telecom values that are email addresses, the corresponding system category is EMAIL. For other communication mediums, the system category is not provided due to ambiguity among representations of phone, fax, and other mediums.
value string true The contact information such as email address or phone number. The formatting of the value is determined by the data source. -
extension string false A number that is dialed after successfully connecting to a private phone network to further route the connection to an internal destination. -
countryCode string false The country code of the telecom. -
effectivePeriod PatientPublicApi_V1_Entities_Period false The period of time when this telecom is valid for the patient. -

PatientPublicApi_V1_Entities_SearchResult

Name Type Required Description Accepted Values
id PatientPublicApi_V1_Entities_PatientReference true A reference to the matching patient. -

PatientPublicApi_V1_Entities_SearchResultList

Name Type Required Description Accepted Values
items [PatientPublicApi_V1_Entities_PatientReference] true A list of patient IDs. -

PatientPublicApi_V1_Entities_AliasParam

Name Type Required Description Accepted Values
value string true The ID issued by the assigning authority. The formatting may vary by source or alias type. Searching by alias is both case- and punctuation-sensitive. -
system string false The authority responsible for assigning the alias value. Alias values may be unique in each system but not across systems. For example, an MRN with a value of 12345 in one hospital’s system may represent a different person than MRN 12345 in a different hospital’s system. Health Data Intelligence avoids identity collisions by indicating the authority that assigned the alias. Ignoring the assigning authority presents security and data integrity concerns, for example, data being associated with the wrong patient or record. -

postPopulationsPopulationidPatientSearch

Name Type Required Description Accepted Values
name string false Filter the response to only patients with at least one matching given or family name value, such as first name, middle name, or last name. This filtering occurs over all current and previous given names. Searching for names is both case- and order-insensitive. -
alias PatientPublicApi_V1_Entities_AliasParam false A patient alias such as MRN, SSN, etc. -
birthDate string false Filter the response to only patients with a date of birth matching the given YYYY-MM-DD or YYYY/MM/DD formatted date string. -
telecom string false Filter the response to only patients with a matching telecom value. Searching by email address is not currently supported. Telecom can be formatted with or without parentheses and hyphens. Searching by country codes is not supported. -
offset integer(int32) false The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit integer(int32) false The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -

SearchResults

Name Type Required Description Accepted Values
items [PatientPublicApi_V1_Entities_SearchResult] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

HealtheintentApi_Common_Models_Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [HealtheintentApi_Common_Models_ErrorDetail] false A list of additional error details. -

HealtheintentApi_Common_Models_ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Demographics

Name Type Required Description Accepted Values
items [PatientPublicApi_V1_Entities_Demographic] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -
Ruby Shell