Patient

{
  "type": "object",
  "properties": {
    "organization_id": {
      "$ref": "#/components/schemas/type_pre-encounter/common:OrganizationId",
      "description": "The organization that owns this object."
    },
    "deactivated": {
      "type": "boolean",
      "description": "True if the object is deactivated.  Deactivated objects are not returned in search results but are returned in all other endpoints including scan."
    },
    "version": {
      "type": "integer",
      "description": "The version of the object. Any update to any property of an object object will create a new version."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "updating_user_id": {
      "$ref": "#/components/schemas/type_pre-encounter/common:UserId",
      "description": "The user ID of the user who last updated the object."
    },
    "name": {
      "$ref": "#/components/schemas/type_pre-encounter/common:HumanName"
    },
    "other_names": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:HumanName"
      },
      "description": "Other names for the patient."
    },
    "other_identifiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:ExternalIdentifier"
      },
      "description": "Other identifiers for the patient."
    },
    "gender": {
      "$ref": "#/components/schemas/type_pre-encounter/common:Gender"
    },
    "birth_date": {
      "type": "string",
      "format": "date"
    },
    "social_security_number": {
      "type": "string"
    },
    "biological_sex": {
      "$ref": "#/components/schemas/type_pre-encounter/common:Sex",
      "description": "The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html"
    },
    "sexual_orientation": {
      "$ref": "#/components/schemas/type_pre-encounter/common:SexualOrientation",
      "description": "The sexual orientation of the patient."
    },
    "pronouns": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The pronouns of the patient."
    },
    "race": {
      "$ref": "#/components/schemas/type_pre-encounter/common:Race"
    },
    "ethnicity": {
      "$ref": "#/components/schemas/type_pre-encounter/common:Ethnicity"
    },
    "disability_status": {
      "$ref": "#/components/schemas/type_pre-encounter/common:DisabilityStatus"
    },
    "marital_status": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:MaritalStatus"
    },
    "deceased": {
      "type": "string",
      "format": "date-time",
      "description": "Time of death for the patient.  Leave unset if the patient is not deceased."
    },
    "multiple_birth": {
      "type": "integer",
      "description": "The number of siblings the patient was born with.  Leave unset if the patient was not part of a multiple birth."
    },
    "primary_address": {
      "$ref": "#/components/schemas/type_pre-encounter/common:Address",
      "description": "The primary address for the patient."
    },
    "other_addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:Address"
      },
      "description": "Other addresses for the patient."
    },
    "primary_telecom": {
      "$ref": "#/components/schemas/type_pre-encounter/common:ContactPoint",
      "description": "The primary phone number for the patient."
    },
    "other_telecoms": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:ContactPoint"
      },
      "description": "Other phone numbers for the patient."
    },
    "email": {
      "type": "string"
    },
    "electronic_communication_opt_in": {
      "type": "boolean",
      "description": "Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations."
    },
    "electronic_communication_consent": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:ElectronicCommunicationConsent",
      "description": "Granular consent for electronic communication channels."
    },
    "photo": {
      "type": "string"
    },
    "language": {
      "type": "string"
    },
    "external_provenance": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:ExternalProvenance",
      "description": "Information about the upstream system that owns this patient data.  Leave unset if Candid owns patient data."
    },
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/patients/v1:Contact"
      },
      "description": "Contacts for the patient."
    },
    "general_practitioners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:ExternalProvider"
      }
    },
    "filing_order": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:FilingOrder"
    },
    "coverages_for_related_causes": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:CoveragesForRelatedCauses"
    },
    "non_insurance_payers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:CanonicalNonInsurancePayerId"
      }
    },
    "non_insurance_payer_associations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:CanonicalNonInsurancePayerAssociation"
      }
    },
    "guarantor": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:Guarantor"
    },
    "self_pay": {
      "type": "boolean"
    },
    "authorizations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/patients/v1:Authorization"
      }
    },
    "referrals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/patients/v1:Referral"
      }
    },
    "primary_service_facility_id": {
      "type": "string"
    },
    "service_facilities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:PatientServiceFacility"
      },
      "description": "Associated service facilities for this patient."
    },
    "do_not_invoice_reason": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:DoNotInvoiceReason",
      "description": "If this value is defined, the customer will not be invoiced."
    },
    "note_ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:NoteId"
      }
    },
    "tag_ids": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/common:TagId"
      }
    },
    "origination_detail": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:OriginationDetail",
      "description": "Information about the patient source, if applicable."
    },
    "inferred_patient_metadata": {
      "$ref": "#/components/schemas/type_pre-encounter/patients/v1:InferredPatientMetadata",
      "description": "Metadata for the patient used for patient inference from encounters."
    },
    "orcon": {
      "type": "boolean",
      "description": "ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false."
    },
    "advanced_directives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/type_pre-encounter/patients/v1:AdvancedDirective"
      }
    },
    "hipaa_code": {
      "type": "string"
    },
    "id": {
      "$ref": "#/components/schemas/type_pre-encounter/common:PatientId",
      "description": "The unique UUID identifier for a Patient.  Patient ID is used in machine contexts."
    },
    "mrn": {
      "type": "string",
      "description": "The medical record number for the patient.  Human-friendly Candid generated MRNs are of the form \"YYMMDDXXXX\", where \"YYMMDD\" is the date of patient creation and \"XXXX\" is a zero-padded incrementing integer."
    }
  },
  "required": [
    "organization_id",
    "deactivated",
    "version",
    "updated_at",
    "updating_user_id",
    "name",
    "other_names",
    "birth_date",
    "biological_sex",
    "primary_address",
    "other_addresses",
    "other_telecoms",
    "contacts",
    "general_practitioners",
    "filing_order",
    "id",
    "mrn"
  ],
  "description": "A patient object with immutable server-owned properties.",
  "title": "Patient",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.joincandidhealth.com/schemas/patient"
}