This data model allows you to locate a patient record based on incomplete identifying information. You can search for a patient by:
- Identifier: Search with an identifier like the patient's MRN. Review tips for searching with a patient identifier.
- Demographics: Search with a patient's name, birthdate, gender, or Social Security number (SSN). Review tips for searching with demographics.
You can only search for a patient at one organization at a time. If you want to search for a patient at multiple organizations, you can use this data model in conjunction with Network Onramps to search a clinical network. Learn about options for patient searches.
This data model has event types that allow you to:
- query for or receive patient records; or
- query for and receive a location's information about a patient.
Receive the relevant patient record(s) based on the query parameters defined in PatientSearch.Query.
If searching with identifier, a successful search returns a full set of patient demographics. If not, the search returns an empty set.
If searching with demographics, your search may return one, many, or no matches.
Request Body Schema
- Metarequired, object
- DataModelrequired, stringReliable
PatientSearch
- EventTyperequired, stringReliable
Response
- EventDateTimestring, nullReliable
Displays the UTC date and time that an outgoing request is delivered or an incoming request is received.
ISO 8601 Format - Testboolean, nullReliable
Indicates whether the request is a test or not.
- Sourceobject
Contains the information for the system initiating the message, including the source ID and name.
Included in messages from Redox- IDstring, nullReliable
Identifies the system initiating the message. If you have multiple OAuth API keys per environment type, this value is required. If you have only one OAuth API key per environment type, or you're using legacy API keys, this value is optional.
UUID - Namestring, nullReliable
Displays the name of the system initiating the message.
- DestinationsArray of object
Contains the information for the endpoint(s) receiving the request. A request must contain at least one destination, but asynchronous requests can have more than one destination. Synchronous requests like queries can only support one destination.
Required when sending data to Redox.- IDstring, nullReliable
Identifies the endpoint that the request is directed to.
UUID - Namestring, nullReliable
Displays the name of the endpoint that the request is directed to.
- LogsArray of object
Contains the log identifier(s) for the request.
- IDstring, nullReliable
Identifies the request log(s) that correspond to this request. You can use this value to locate the relevant log in the Redox dashboard for support and reference.
UUID - AttemptIDstring, nullReliable
Identifies the request log attempt value, which is useful when retries are possible.
UUID
- FacilityCodestring, nullPossible
Code for the facility related to the message.
Only use this field if a health system indicates you should. The code is specific to the health system's EHR and might not be unique across health systems. In general, the facility fields within the data models (e.g. OrderingFacility) are more reliable and informative. - IsIncompleteboolean, nullReliable
Indicates that a limit was reached, and not all data was returned. If true, the sender may want to restrict the parameters of the request in order to match fewer results.
- Patientobject
- IdentifiersArray of object
List of IDs and ID types that identify the patient
- IDstring, nullReliable
ID for the patient
- IDTypestring, nullReliable
Type of ID.
E.g. MRN, EPI
- Demographicsobject
- FirstNamestring, nullReliable
Patient's first name
- MiddleNamestring, nullPossible
Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- LastNamestring, nullReliable
Patient's last name
- DOBstring, nullReliable
Patient's date of birth.
In ISO 8601 format - SSNstring, nullProbable
Patient's social security number
- Sexstring, nullReliableValue Set
Patient's sex
- Racestring, nullPossibleValue Set
Patient's race
- IsHispanicboolean, nullPossibleValue Set
Indicates if the patient is of hispanic origin.
- Religionstring, nullPossibleValue Set
Patient's religious affiliation
- MaritalStatusstring, nullPossibleValue Set
Patient's marital status
- IsDeceasedboolean, nullPossible
Indicates if the patient is deceased
- DeathDateTimestring, nullPossible
Date and Time the patient was proclaimed deceased.
ISO 8601 Format - PhoneNumberobject
- Homestring, nullProbable
Patient's home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullProbable
Patient's office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- EmailAddressesArray of string
Patient's email address(es)
- Languagestring, nullPossibleValue Set
Patient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values - CitizenshipArray of string
Patient's nation(s) of citizenship.
In ISO 3166 alpha 2 format (e.g. 'US'). - Addressobject
Patient's home address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- NotesArray of string
Patient-level notes
- ContactsArray of object
- FirstNamestring, nullPossible
First name of the contact
- MiddleNamestring, nullPossible
Middle name of the contact
- LastNamestring, nullPossible
Last name of the contact
- Addressobject
Address of the contact
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullPossible
Home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullPossible
Office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- RelationToPatientstring, nullPossibleValue Set
Personal relationship to the patient.
e.x. Father, Spouse - EmailAddressesArray of string
Email address(es) of the contact person
- RolesArray of string
Role of this contact for the patient.
e.x. Employer, Emergency Contact
- PCPobject
Primary Care Provider for the Patient
- NPIstring, nullReliable
NPI of the PCP
- IDstring, nullReliable
ID of the PCP.
This ID is often required for Inpatient Visits. - IDTypestring, nullReliable
ID type of the ID for the PCP
- FirstNamestring, nullPossible
First name of the PCP
- LastNamestring, nullPossible
Last name of the PCP
- CredentialsArray of string
List of credentials for the PCP.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- Guarantorobject
Person ultimately responsible for the patient's bills
- Numberstring, nullProbable
Number of the guarantor
- FirstNamestring, nullProbable
First name
- MiddleNamestring, nullPossible
Middle name
- LastNamestring, nullProbable
Last name
- SSNstring, nullPossible
Guarantor's social security number
- DOBstring, nullPossible
Guarantor's date of birth.
In ISO 8601 format - Sexstring, nullPossibleValue Set
Guarantor's sex.
One of the following: Female, Male, Unknown, Other - Spouseobject
- FirstNamestring, nullProbable
Spouse's first name
- LastNamestring, nullProbable
Spouse's last name
- Addressobject
Address of the guarantor
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullProbable
Home phone number.
In E. 164 Format (i.e. +16085551234) - Businessstring, nullProbable
Business phone number.
In E. 164 Format (i.e. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format (i.e. +16085551234)
- EmailAddressesArray of string
Guarantor's email address(es)
- Typestring, nullProbable
Type of guarantor.
E.g. institution, individual - RelationToPatientstring, nullProbableValue Set
Relation to the patient
- Employerobject
- Namestring, nullProbable
Employer's name
- Addressobject
Employer's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullProbable
Employer phone number.
In E. 164 Format (i.e. +16085551234)
- InsurancesArray of object
List of insurance coverages for the patient
- Planobject
- IDstring, nullProbable
Identifier of insurance plan
- IDTypestring, nullProbable
ID type of insurance plan
- Namestring, nullProbable
Name of insurance plan
- Typestring, nullPossible
Type of insurance plan
- MemberNumberstring, nullPossible
Patient member number
- Companyobject
- IDstring, nullProbable
ID of insurance company (payor)
- IDTypestring, nullProbable
ID type of insurance company (payor)
- Namestring, nullProbable
Name of insurance company (payor)
- Addressobject
Insurance company's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullProbable
Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)
- GroupNumberstring, nullProbable
Insurance policy group number
- GroupNamestring, nullProbable
Insurance policy group name
- EffectiveDatestring, nullProbable
Effect date of this insurance policy.
In YYYY-MM-DD format - ExpirationDatestring, nullProbable
Expiration date of this insurance policy.
In YYYY-MM-DD format - PolicyNumberstring, nullProbable
Insurance policy number
- Prioritystring, nullPossibleValue Set
The insurance priority sequence.
If the insurance works in conjunction with other insurance plans, this field contains priority sequence. - AgreementTypestring, nullProbableValue Set
Type of insurance agreement.
- CoverageTypestring, nullProbableValue Set
Type of insurance agreement.
Indicates who will be receiving the bill for the service. - Insuredobject
Individual who has the agreement with the insurance company for the related policy
- IdentifiersArray of object
List of IDs and ID types that identify the insured
- IDstring, nullPossible
ID for the insured
- IDTypestring, nullPossible
Type of ID.
E.g. MRN, EPI
- LastNamestring, nullPossible
Last name of the insured
- MiddleNamestring, nullPossible
Middle name of the insured
- FirstNamestring, nullPossible
First name of the insured
- SSNstring, nullPossible
Insured's social security number
- Relationshipstring, nullPossibleValue Set
Relationship of the insured to the patient
- DOBstring, nullPossible
Date of birth of the insured.
In YYYY-MM-DD format - Sexstring, nullPossibleValue Set
Sex of the insured
- Addressobject
Address of the insured
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PotentialMatchesArray of object
- IdentifiersArray of object
List of IDs and ID types that identify the patient
- IDstring, nullReliable
ID for the patient
- IDTypestring, nullReliable
Type of ID.
E.g. MRN, EPI
- Demographicsobject
- FirstNamestring, nullReliable
Patient's first name
- MiddleNamestring, nullPossible
Patient's middle name or middle initial. For patients with multiple middle names, all their middle names are included in this field.
- LastNamestring, nullReliable
Patient's last name
- DOBstring, nullReliable
Patient's date of birth.
In ISO 8601 format - SSNstring, nullProbable
Patient's social security number
- Sexstring, nullReliableValue Set
Patient's sex
- Racestring, nullPossibleValue Set
Patient's race
- IsHispanicboolean, nullPossibleValue Set
Indicates if the patient is of hispanic origin.
- Religionstring, nullPossibleValue Set
Patient's religious affiliation
- MaritalStatusstring, nullPossibleValue Set
Patient's marital status
- IsDeceasedboolean, nullPossible
Indicates if the patient is deceased
- DeathDateTimestring, nullPossible
Date and Time the patient was proclaimed deceased.
ISO 8601 Format - PhoneNumberobject
- Homestring, nullProbable
Patient's home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullProbable
Patient's office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Patient's mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- EmailAddressesArray of string
Patient's email address(es)
- Languagestring, nullPossibleValue Set
Patient's primary spoken language.
In ISO 639-1 alpha values (e.g. 'en'). Supported Values - CitizenshipArray of string
Patient's nation(s) of citizenship.
In ISO 3166 alpha 2 format (e.g. 'US'). - Addressobject
Patient's home address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- NotesArray of string
Patient-level notes
- ContactsArray of object
- FirstNamestring, nullPossible
First name of the contact
- MiddleNamestring, nullPossible
Middle name of the contact
- LastNamestring, nullPossible
Last name of the contact
- Addressobject
Address of the contact
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullPossible
Home phone number.
In E. 164 Format. (e.g. +16085551234) - Officestring, nullPossible
Office phone number.
In E. 164 Format. (e.g. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format. (e.g. +16085551234)
- RelationToPatientstring, nullPossibleValue Set
Personal relationship to the patient.
e.x. Father, Spouse - EmailAddressesArray of string
Email address(es) of the contact person
- RolesArray of string
Role of this contact for the patient.
e.x. Employer, Emergency Contact
- PCPobject
Primary Care Provider for the potentially matching patient
- NPIstring, nullReliable
NPI of the PCP
- IDstring, nullReliable
ID of the PCP.
This ID is often required for Inpatient Visits. - IDTypestring, nullReliable
ID type of the ID for the PCP
- FirstNamestring, nullPossible
First name of the PCP
- LastNamestring, nullPossible
Last name of the PCP
- CredentialsArray of string
List of credentials for the PCP.
e.g. MD, PhD - Addressobject
Provider's address
- StreetAddressstring, nullPossible
Street address
- Citystring, nullPossible
City
- Statestring, nullPossible
State
- ZIPstring, nullPossible
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- EmailAddressesArray of string
Provider's email address(es)
- PhoneNumberobject
- Officestring, nullPossible
Provider's office phone number.
In E. 164 Format. (e.g. +16085551234)
- Locationobject
Provider's location
- Typestring, nullPossible
Type of location.
Examples: Clinic, Department, Home, Nursing Unit, Provider's Office, Phone - Facilitystring, nullPossible
Facility.
Example: Community Hospital - FacilityIdentifiersArray of object
List of IDs specific to this facility
- IDstring, nullPossible
An ID specific to this facility
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Departmentstring, nullPossible
Department
- DepartmentIdentifiersArray of object
List of IDs specific to this department
- IDstring, nullPossible
An ID specific to this department
- IDTypestring, nullPossible
The source or system to which this ID pertains.
Could be an OID or a human-readable name
- Roomstring, nullPossible
Room.
Example: 136
- Guarantorobject
Person ultimately responsible for each potentially matching patient's bills
- Numberstring, nullProbable
Number of the guarantor
- FirstNamestring, nullProbable
First name
- MiddleNamestring, nullPossible
Middle name
- LastNamestring, nullProbable
Last name
- SSNstring, nullPossible
Guarantor's social security number
- DOBstring, nullPossible
Guarantor's date of birth.
In ISO 8601 format - Sexstring, nullPossibleValue Set
Guarantor's sex.
One of the following: Female, Male, Unknown, Other - Spouseobject
- FirstNamestring, nullProbable
Spouse's first name
- LastNamestring, nullProbable
Spouse's last name
- Addressobject
Address of the guarantor
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberobject
- Homestring, nullProbable
Home phone number.
In E. 164 Format (i.e. +16085551234) - Businessstring, nullProbable
Business phone number.
In E. 164 Format (i.e. +16085551234) - Mobilestring, nullProbable
Mobile phone number.
In E. 164 Format (i.e. +16085551234)
- EmailAddressesArray of string
Guarantor's email address(es)
- Typestring, nullProbable
Type of guarantor.
E.g. institution, individual - RelationToPatientstring, nullProbableValue Set
Relation to the patient
- Employerobject
- Namestring, nullProbable
Employer's name
- Addressobject
Employer's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullProbable
Employer phone number.
In E. 164 Format (i.e. +16085551234)
- InsurancesArray of object
List of insurance coverages for each potentially matching patient
- Planobject
- IDstring, nullProbable
Identifier of insurance plan
- IDTypestring, nullProbable
ID type of insurance plan
- Namestring, nullProbable
Name of insurance plan
- Typestring, nullPossible
Type of insurance plan
- MemberNumberstring, nullPossible
Patient member number
- Companyobject
- IDstring, nullProbable
ID of insurance company (payor)
- IDTypestring, nullProbable
ID type of insurance company (payor)
- Namestring, nullProbable
Name of insurance company (payor)
- Addressobject
Insurance company's address
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country
- PhoneNumberstring, nullProbable
Insurance companys phone number.
In E. 164 Format (i.e. +16085551234)
- GroupNumberstring, nullProbable
Insurance policy group number
- GroupNamestring, nullProbable
Insurance policy group name
- EffectiveDatestring, nullProbable
Effect date of this insurance policy.
In YYYY-MM-DD format - ExpirationDatestring, nullProbable
Expiration date of this insurance policy.
In YYYY-MM-DD format - PolicyNumberstring, nullProbable
Insurance policy number
- Prioritystring, nullPossibleValue Set
The insurance priority sequence.
If the insurance works in conjunction with other insurance plans, this field contains priority sequence. - AgreementTypestring, nullProbableValue Set
Type of insurance agreement.
- CoverageTypestring, nullProbableValue Set
Type of insurance agreement.
Indicates who will be receiving the bill for the service. - Insuredobject
Individual who has the agreement with the insurance company for the related policy
- IdentifiersArray of object
List of IDs and ID types that identify the insured
- IDstring, nullPossible
ID for the insured
- IDTypestring, nullPossible
Type of ID.
E.g. MRN, EPI
- LastNamestring, nullPossible
Last name of the insured
- MiddleNamestring, nullPossible
Middle name of the insured
- FirstNamestring, nullPossible
First name of the insured
- SSNstring, nullPossible
Insured's social security number
- Relationshipstring, nullPossibleValue Set
Relationship of the insured to the patient
- DOBstring, nullPossible
Date of birth of the insured.
In YYYY-MM-DD format - Sexstring, nullPossibleValue Set
Sex of the insured
- Addressobject
Address of the insured
- StreetAddressstring, nullProbable
Street address
- Citystring, nullProbable
City
- Statestring, nullProbable
State
- ZIPstring, nullProbable
ZIP
- Countystring, nullPossible
County
- Countrystring, nullPossibleValue Set
Country