1. REST APIs for Oracle Health Clinical Data Exchange
  2. Tasks
  3. Patient

Get a patient list

get

/fhir/r4/{query_endpoint_alias}/Patient

This path retrieves a list of patients that meet supplied query parameters.

The Oracle Health Clinical Data Exchange engine has an enterprise master patient index (EMPI), which uses the search matrix algorithm when matching patients to your search criteria.

Each patient is matched for each item on the following list:

  • LN: Patient last name
  • FN: Patient first name
  • DOB: Patient date of birth
  • SSN: Social Security Number
  • Address: Concatenation of AddressLine1, AddressLine2 and sub-rule evaluation of Postal Code values
  • Phone: Phone number provided, can be mobile, home, or work

The following list is ranked in priority from highest to lowest:

LN FN DOB SSN Address Phone Result
yes yes yes yes yes yes yes
yes yes yes yes yes no yes
yes yes yes yes no yes yes
yes yes yes yes no no yes
yes yes yes no yes yes
exact yes
yes yes yes no yes no
exact yes
yes yes yes no no yes
exact yes
yes yes yes no no no
exactAndMaxFreq(0.001) exact unknown postalMatches yes
exactAndMaxFreq(0.001) exact unknown address1Matches yes
exactAndMaxFreq(0.0.0001) exact unknown yes
exactAndMinLNFNDOBUnqProb(99.0) exact unknown unknown unknown yes
yes yes no yes yes yes yes
yes yes no yes yes no yes
yes yes no yes no yes yes
yes yes no yes no no yes
yes yes no no yes yes
yearMatches yes
yes yes no no yes no
exact exact yearMatches unknown unknown yes
yes yes no no no yes
yearMatches unknown yes
yes no yes yes yes yes
exact yes
yes no yes yes yes no
exact yes
yes no yes yes no yes
exactAndMinLNFNDOBUnqProb(99.9) exact unknown unknown yes

Sub-rules are the only rule sets that can make use of the following functions (normal rules are only YES/NO):

  • Unknown: If the field is unknown rather than a known, different value
  • yearMatches: Year of DOB value matches
  • maxlev(x): Custom Levenshtein evaluation tolerance
  • exact: Fields are exact character match
  • exactAndMaxFreq(x): If fields are exact match and the content occurs in less than x-value percent of total patient population
  • postalMatches: Postal code of the address field matches

Request

Query Parameters
Header Parameters
Back to Top

Response

Supported Media Types

200 Response

Success
- The response would include all the entries matched.

Headers
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : Patient
Type: object
The Patient FHIR resource.
Show Source
Example:
{
  "resourceType": "Patient",
  "id": "2586450001",
  "identifier": [
      {
          "use": "usual",
          "type": {
              "coding": [
                  {
                      "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                      "code": "MR",
                      "display": "Medical record number"
                  }
              ]
          },
          "system": "891c71549f4a4bb439b4de8a532f155c_2.16.840.1.113883.3.995.10.1.1",
          "value": "8133"
      },
      {
          "use": "SSN",
          "type": {
              "coding": [
                  {
                      "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
                      "code": "SS"
                  }
              ],
              "text": "SSN"
          },
          "system": "http://hl7.org/fhir/sid/us-ssn",
          "value": "991123333"
      }
  ],
  "name": [
      {
          "use": "official",
          "family": "PEREZ",
          "given": [
              "JUAN"
          ]
      }
  ],
  "telecom": [
      {
          "system": "phone",
          "value": "123-123-1234",
          "use": "home"
      }
  ],
  "gender": "male",
  "birthdate": "1985-07-09",
  "deceasedBoolean": true,
  "deceasedDateTime": "2015-02-14T13:42:00Z",
  "maritalStatus": {
      "coding": [
          {
              "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus",
              "code": "M"
          }
      ]
  },
  "address": [
      {
          "use": "home",
          "text": "1234, SAMPLE ROAD CITYTOWN, ST 56789",
          "line": [
              "1234, SAMPLE ROAD"
          ],
          "city": "CITYTOWN",
          "state": "ST",
          "postalCode": "56789"
      }
  ],
  "communication": [
      {
          "language": {
              "coding": [
                  {
                      "system": "urn:ietf:bcp:47",
                      "code": "nl-NL",
                      "display": "Dutch"
                  }
              ]
          },
          "preferred": true
      }
  ]
}
Nested Schema : address
Type: array
Minimum Number of Items: 1
Unique Items Required: true
Show Source
Nested Schema : communication
Type: array
Minimum Number of Items: 1
Unique Items Required: true
A language that may be used to communicate with the patient about their health
Show Source
Nested Schema : deceased
Type: object
Show Source
Nested Schema : identifier
Type: array
Minimum Number of Items: 1
Unique Items Required: true
The list of unique identifiers across all the providers and the associated Social Security numbers (SSNs) are returned. The supported system is http://terminology.hl7.org/CodeSystem/v2-0203.
Show Source
Nested Schema : CodeableConcept
Match All
Show Source
Nested Schema : name
Type: array
Minimum Number of Items: 1
Unique Items Required: true
Show Source
Nested Schema : telecom
Type: array
Show Source
Nested Schema : Address
Match All
Show Source
Nested Schema : Element
Type: object
Show Source
Nested Schema : Address-allOf[1]
Type: object
Show Source
Nested Schema : extension
Type: array
Show Source
Nested Schema : Extension
Type: object
Show Source
  • Minimum Length: 1
    Identifies the meaning of the extension.
  • Minimum Length: 1
    The value of the extension.
Nested Schema : line
Type: array
The street name, number, direction, P.O. Box, and so on.
Show Source
Nested Schema : Period
Match All
Show Source
Nested Schema : Period-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Match All
Show Source
Nested Schema : BackBoneElement
Match All
Show Source
Nested Schema : BackBoneElement-allOf[1]
Type: object
Show Source
Nested Schema : items-allOf[1]
Type: object
Nested Schema : Identifier
Match All
Show Source
Nested Schema : Identifier-allOf[1]
Type: object
Show Source
Nested Schema : CodeableConcept-allOf[1]
Type: object
Show Source
Nested Schema : coding
Type: array
A reference to a code defined by a terminology system.
Show Source
Nested Schema : Coding
Match All
Show Source
Nested Schema : Coding-allOf[1]
Type: object
Show Source
Nested Schema : HumanName
Match All
Show Source
Nested Schema : HumanName-allOf[1]
Type: object
Show Source
Nested Schema : given
Type: array
The given name (not always the first name). Includes middle names.
Show Source
Nested Schema : prefix
Type: array
Show Source
Nested Schema : suffix
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

400 Response

Bad Request.

401 Response

Authorization information is missing or invalid.

403 Response

The user does not have sufficient access to perform this action.

500 Response

Internal Server error.
Back to Top