# Preview Patient Merging

Return a preview of a merge between two patients hand provide a merge token

Endpoint: POST /v1/patients/{id}/merge/preview
Version: 1.0.0
Security: apiKeyAuth, practiceGroupId

## Security:

  - `apiKeyAuth` (unknown)
    apiKey in header x-api-key

  - `practiceGroupId` (unknown)
    apiKey in header x-practice-group-id

## Path parameters:

  - `id` (string, required)

## Request fields (application/json):

  - `patient_id` (string, required)

## Response 200:

  - `200` (unknown)
    Ok

## Response 200 fields (application/json):

  - `main_patient` (object, required)

  - `main_patient.id` (string, required)

  - `main_patient.uid` (string)

  - `main_patient.emis_id` (string)

  - `main_patient.ehr_partner_id` (string)

  - `main_patient.dob` (string, required)

  - `main_patient.deceased_at` (string)

  - `main_patient.title` (string)
    Enum: "Baron", "Baroness", "Brigadier", "Count", "Colonel", "Countess", "Captain", "Dame", "The Dowager Viscountess", "Dr", "Duchess", "Duke", "Earl", "His Excellency", "Father", "H.E. Ambassador Mr", "H.E. Mr", "H.E. Mrs", "Her Grace", "His Grace", "The Hon", "The Hon Mr", "The Hon Mrs", "HRH", "HRH Prince", "HRH Princess", "Insurance", "HM King", "Lady", "Lord", "Major", "Master", "Miss", "Mr", "Mrs", "Ms", "Mss", "Mx", "Pr", "Professor", "HM Queen", "Rabbi", "Reverend", "Sheikh", "Sheikha", "Sir", "The", "", "Viscount", "Viscountess"

  - `main_patient.first_name` (string)

  - `main_patient.last_name` (string)

  - `main_patient.sex` (string)
    Enum: "Not known", "Not specified", "Male", "Female", "Other"

  - `main_patient.nhs_number` (string)

  - `main_patient.email` (string)

  - `main_patient.emails` (array)

  - `main_patient.mobile` (string)

  - `main_patient.last_sync_at` (string)

  - `main_patient.address_line_1` (string)

  - `main_patient.address_line_2` (string)

  - `main_patient.address_line_3` (string)

  - `main_patient.country` (string)

  - `main_patient.postcode` (string)

  - `main_patient.town` (string)

  - `main_patient.county` (string)

  - `main_patient.notes` (string)

  - `main_patient.verification_credentials` (array)

  - `main_patient.patient_memberships` (array)

  - `main_patient.patient_memberships.id` (string, required)

  - `main_patient.patient_memberships.active` (boolean, required)

  - `main_patient.patient_memberships.membership` (object, required)

  - `main_patient.patient_memberships.membership.id` (string)

  - `main_patient.patient_memberships.membership.name` (string, required)

  - `main_patient.patient_memberships.membership.length` (string, required)
    Enum: "yearly", "monthly"

  - `main_patient.data_source` (string, required)
    Enum: "hero", "emis", "pds", "gha", "systm_one"

  - `main_patient.restricted` (boolean)

  - `main_patient.sex_changed_at` (string)

  - `main_patient.status` (string, required)
    Enum: "archived", "unarchived"

  - `main_patient.ods_code` (string)

  - `main_patient.identifiers` (array, required)

  - `main_patient.identifiers.source` (string, required)
    Enum: "nhs", "gha", "ehr_partner", "hero"

  - `main_patient.identifiers.name` (string, required)
    Enum: "nhs_number", "gha_number", "ehr_partner_id", "hero_id", "hero_uid"

  - `main_patient.identifiers.role` (string, required)
    Enum: "main", "secondary"

  - `main_patient.identifiers.label` (string, required)
    Enum: "NHS", "GHA", "EMIS", "Hero", "Systm One"

  - `main_patient.identifiers.value` (string, required)

  - `main_patient.ehr_registered` (boolean, required)

  - `incoming_patient` (object, required)

  - `incoming_patient.id` (string, required)

  - `incoming_patient.uid` (string)

  - `incoming_patient.emis_id` (string)

  - `incoming_patient.ehr_partner_id` (string)

  - `incoming_patient.dob` (string, required)

  - `incoming_patient.deceased_at` (string)

  - `incoming_patient.title` (string)
    Enum: "Baron", "Baroness", "Brigadier", "Count", "Colonel", "Countess", "Captain", "Dame", "The Dowager Viscountess", "Dr", "Duchess", "Duke", "Earl", "His Excellency", "Father", "H.E. Ambassador Mr", "H.E. Mr", "H.E. Mrs", "Her Grace", "His Grace", "The Hon", "The Hon Mr", "The Hon Mrs", "HRH", "HRH Prince", "HRH Princess", "Insurance", "HM King", "Lady", "Lord", "Major", "Master", "Miss", "Mr", "Mrs", "Ms", "Mss", "Mx", "Pr", "Professor", "HM Queen", "Rabbi", "Reverend", "Sheikh", "Sheikha", "Sir", "The", "", "Viscount", "Viscountess"

  - `incoming_patient.first_name` (string)

  - `incoming_patient.last_name` (string)

  - `incoming_patient.sex` (string)
    Enum: "Not known", "Not specified", "Male", "Female", "Other"

  - `incoming_patient.nhs_number` (string)

  - `incoming_patient.email` (string)

  - `incoming_patient.emails` (array)

  - `incoming_patient.mobile` (string)

  - `incoming_patient.last_sync_at` (string)

  - `incoming_patient.address_line_1` (string)

  - `incoming_patient.address_line_2` (string)

  - `incoming_patient.address_line_3` (string)

  - `incoming_patient.country` (string)

  - `incoming_patient.postcode` (string)

  - `incoming_patient.town` (string)

  - `incoming_patient.county` (string)

  - `incoming_patient.notes` (string)

  - `incoming_patient.verification_credentials` (array)

  - `incoming_patient.patient_memberships` (array)

  - `incoming_patient.patient_memberships.id` (string, required)

  - `incoming_patient.patient_memberships.active` (boolean, required)

  - `incoming_patient.patient_memberships.membership` (object, required)

  - `incoming_patient.patient_memberships.membership.id` (string)

  - `incoming_patient.patient_memberships.membership.name` (string, required)

  - `incoming_patient.patient_memberships.membership.length` (string, required)
    Enum: "yearly", "monthly"

  - `incoming_patient.data_source` (string, required)
    Enum: "hero", "emis", "pds", "gha", "systm_one"

  - `incoming_patient.restricted` (boolean)

  - `incoming_patient.sex_changed_at` (string)

  - `incoming_patient.status` (string, required)
    Enum: "archived", "unarchived"

  - `incoming_patient.ods_code` (string)

  - `incoming_patient.identifiers` (array, required)

  - `incoming_patient.identifiers.source` (string, required)
    Enum: "nhs", "gha", "ehr_partner", "hero"

  - `incoming_patient.identifiers.name` (string, required)
    Enum: "nhs_number", "gha_number", "ehr_partner_id", "hero_id", "hero_uid"

  - `incoming_patient.identifiers.role` (string, required)
    Enum: "main", "secondary"

  - `incoming_patient.identifiers.label` (string, required)
    Enum: "NHS", "GHA", "EMIS", "Hero", "Systm One"

  - `incoming_patient.identifiers.value` (string, required)

  - `incoming_patient.ehr_registered` (boolean, required)

  - `result_patient` (object, required)

  - `result_patient.id` (string, required)

  - `result_patient.uid` (string)

  - `result_patient.emis_id` (string)

  - `result_patient.ehr_partner_id` (string)

  - `result_patient.dob` (string, required)

  - `result_patient.deceased_at` (string)

  - `result_patient.title` (string)
    Enum: "Baron", "Baroness", "Brigadier", "Count", "Colonel", "Countess", "Captain", "Dame", "The Dowager Viscountess", "Dr", "Duchess", "Duke", "Earl", "His Excellency", "Father", "H.E. Ambassador Mr", "H.E. Mr", "H.E. Mrs", "Her Grace", "His Grace", "The Hon", "The Hon Mr", "The Hon Mrs", "HRH", "HRH Prince", "HRH Princess", "Insurance", "HM King", "Lady", "Lord", "Major", "Master", "Miss", "Mr", "Mrs", "Ms", "Mss", "Mx", "Pr", "Professor", "HM Queen", "Rabbi", "Reverend", "Sheikh", "Sheikha", "Sir", "The", "", "Viscount", "Viscountess"

  - `result_patient.first_name` (string)

  - `result_patient.last_name` (string)

  - `result_patient.sex` (string)
    Enum: "Not known", "Not specified", "Male", "Female", "Other"

  - `result_patient.nhs_number` (string)

  - `result_patient.email` (string)

  - `result_patient.emails` (array)

  - `result_patient.mobile` (string)

  - `result_patient.last_sync_at` (string)

  - `result_patient.address_line_1` (string)

  - `result_patient.address_line_2` (string)

  - `result_patient.address_line_3` (string)

  - `result_patient.country` (string)

  - `result_patient.postcode` (string)

  - `result_patient.town` (string)

  - `result_patient.county` (string)

  - `result_patient.notes` (string)

  - `result_patient.verification_credentials` (array)

  - `result_patient.patient_memberships` (array)

  - `result_patient.patient_memberships.id` (string, required)

  - `result_patient.patient_memberships.active` (boolean, required)

  - `result_patient.patient_memberships.membership` (object, required)

  - `result_patient.patient_memberships.membership.id` (string)

  - `result_patient.patient_memberships.membership.name` (string, required)

  - `result_patient.patient_memberships.membership.length` (string, required)
    Enum: "yearly", "monthly"

  - `result_patient.data_source` (string, required)
    Enum: "hero", "emis", "pds", "gha", "systm_one"

  - `result_patient.restricted` (boolean)

  - `result_patient.sex_changed_at` (string)

  - `result_patient.status` (string, required)
    Enum: "archived", "unarchived"

  - `result_patient.ods_code` (string)

  - `result_patient.identifiers` (array, required)

  - `result_patient.identifiers.source` (string, required)
    Enum: "nhs", "gha", "ehr_partner", "hero"

  - `result_patient.identifiers.name` (string, required)
    Enum: "nhs_number", "gha_number", "ehr_partner_id", "hero_id", "hero_uid"

  - `result_patient.identifiers.role` (string, required)
    Enum: "main", "secondary"

  - `result_patient.identifiers.label` (string, required)
    Enum: "NHS", "GHA", "EMIS", "Hero", "Systm One"

  - `result_patient.identifiers.value` (string, required)

  - `result_patient.ehr_registered` (boolean, required)

  - `merge_token` (string, required)

## Response 400:

  - `400` (unknown)
    Validation error

## Response 400 fields (application/json):

  - `error` (boolean, required)
    Example: true

  - `statusCode` (number, required)
    Example: 400

  - `message` (array, required)

  - `message.code` (string, required)
    Example: invalid_type

  - `message.expected` (string, required)
    Example: string

  - `message.path` (array, required)
    Example: ["patient_id"]

  - `message.message` (string, required)
    Example: Required

## Response 401:

  - `401` (unknown)
    Unauthorised

## Response 404:

  - `404` (unknown)
    Not found

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 500:

  - `500` (unknown)
    Unknown error