Hint Health · Schema

Create_Patient

Direct Primary CareDPCHealthcareMembership ManagementPatient EnrollmentMedical BillingEMRHealth Plans

Properties

Name	Type	Description
first_name	string	This should be the patients legal first name.
last_name	string	This should be the patients legal last name.
middle_name	string	This should be the patients legal middle name.
title	string
suffix	string
chosen_first_name	string
chosen_last_name	string
chosen_middle_name	string
chosen_title	string
chosen_suffix	string
pronouns	string	May be one of `He/Him/His`, `She/Her/Hers` or `They/Them/Theirs`. Other values sent will be stored as free text.
email	string
sex	string	May send `male`, `female`, or `intersex`.
gender	string	This field will be deprecated on March 31st 2021.
gender_identity	string	May send `man`, `woman`, `trans man`, `trans woman`, `nonbinary`, or `not listed`. If you send `not listed`, please include a description in the `gender_other` field.
gender_other	string	Used to specify gender identity, when not listed.
dob	string	Date must be formatted as YYYY-MM-DD.
lead_source	object
practitioner	object
location	object
emergency_contact	object
phones	array
ssn	object
health_insurance_group_id	string
health_insurance_member_id	string
health_insurance_payer_name	string
health_insurance_payer_id	string
address_line1	string
address_line2	string
address_city	string
address_state	string
address_zip	string
address_country	string
import_id	string	(deprecated)
import_source	string	(deprecated)
external_link_id	string	(deprecated)
integration_record_id	string
integration_error_message	string
integration_web_link	string
last_engagement_date	string	Date must be formatted as YYYY-MM-DD.
electronic_communication_consent_accepted	boolean
patient_agreement_accepted	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.hint.com/schemas/provider-patientscontroller-update_body",
  "title": "Create_Patient",
  "type": "object",
  "properties": {
    "first_name": {
      "type": "string",
      "description": "This should be the patients legal first name."
    },
    "last_name": {
      "type": "string",
      "description": "This should be the patients legal last name."
    },
    "middle_name": {
      "type": "string",
      "description": "This should be the patients legal middle name."
    },
    "title": {
      "type": "string"
    },
    "suffix": {
      "type": "string"
    },
    "chosen_first_name": {
      "type": "string"
    },
    "chosen_last_name": {
      "type": "string"
    },
    "chosen_middle_name": {
      "type": "string"
    },
    "chosen_title": {
      "type": "string"
    },
    "chosen_suffix": {
      "type": "string"
    },
    "pronouns": {
      "type": "string",
      "description": "May be one of `He/Him/His`, `She/Her/Hers` or `They/Them/Theirs`. Other values sent will be stored as free text."
    },
    "email": {
      "type": "string"
    },
    "sex": {
      "type": "string",
      "description": "May send `male`, `female`, or `intersex`."
    },
    "gender": {
      "type": "string",
      "description": "This field will be deprecated on March 31st 2021."
    },
    "gender_identity": {
      "type": "string",
      "description": "May send `man`, `woman`, `trans man`, `trans woman`, `nonbinary`, or `not listed`. If you send `not listed`, please include a description in the `gender_other` field."
    },
    "gender_other": {
      "type": "string",
      "description": "Used to specify gender identity, when not listed."
    },
    "dob": {
      "type": "string",
      "format": "date",
      "description": "Date must be formatted as YYYY-MM-DD."
    },
    "lead_source": {
      "$ref": "#/components/schemas/Association"
    },
    "practitioner": {
      "$ref": "#/components/schemas/Association"
    },
    "location": {
      "$ref": "#/components/schemas/Association"
    },
    "emergency_contact": {
      "$ref": "#/components/schemas/EmergencyContact"
    },
    "phones": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PhoneNumber"
      }
    },
    "ssn": {
      "$ref": "#/components/schemas/SocialSecurityNumber"
    },
    "health_insurance_group_id": {
      "type": "string"
    },
    "health_insurance_member_id": {
      "type": "string"
    },
    "health_insurance_payer_name": {
      "type": "string"
    },
    "health_insurance_payer_id": {
      "type": "string"
    },
    "address_line1": {
      "type": "string"
    },
    "address_line2": {
      "type": "string"
    },
    "address_city": {
      "type": "string"
    },
    "address_state": {
      "type": "string"
    },
    "address_zip": {
      "type": "string"
    },
    "address_country": {
      "type": "string"
    },
    "import_id": {
      "type": "string",
      "description": "(deprecated)"
    },
    "import_source": {
      "type": "string",
      "description": "(deprecated)"
    },
    "external_link_id": {
      "type": "string",
      "description": "(deprecated)"
    },
    "integration_record_id": {
      "type": "string"
    },
    "integration_error_message": {
      "type": "string"
    },
    "integration_web_link": {
      "type": "string"
    },
    "last_engagement_date": {
      "type": "string",
      "format": "date",
      "description": "Date must be formatted as YYYY-MM-DD."
    },
    "electronic_communication_consent_accepted": {
      "type": "boolean"
    },
    "patient_agreement_accepted": {
      "type": "boolean"
    }
  },
  "required": [
    "first_name",
    "last_name"
  ]
}