Endpoint: /Patient/Match

This endpoint provides a method for Api consumers to attempt to retrieve a GEHRIMED PatientID should the patient already exist in the system, so as to join identifiers on a common record rather than risking patient record duplication.

Note: Providing information that returns more than one patient record match, while highly unlikely, will return a PatientMatch exception.

Request : JSON

{
	"DOB": string,
	"First": string,
	"Last": string,
	"SSN": string,
	"Gender": string
}

Field	Data Type	Required	Comments
First	String	Required	First name of patient.
Last	String	Required	Last name of patient.
DOB	Date	Required	Date of birth of patient in format yyyy-mm-dd.
SSN	Integer	Required	SSN of patient, numeric only.
Gender	String	Required	Gender of patient. Valid codes are M, F, and U.

Response : JSON

{
	"Metadata": {
        "ApiSender": string,
        "ApiConsumer": string,
        "MessageDateTime": DateTime
	},
    "Data": {
		"PatientMatch": {
			"Success": bool,
			"PatientID": int,
			"Message": string
		}
	}
}

Field	Data Type	Comments
Metadata	Metadata	See Response Metadata section.
Data	Data	Data wrapper.
Data.PatientMatch	PatientMatch	PatientMatch wrapper.
Data.PatientMatch.Success	Boolean	True if a match was found, else false.
Data.PatientMatch.PatientID	Long	If a match was found, GEHRIMED PatientID of the matching patient. Used for subsequent requests for patient data.