api-docs v5.116.0

API Docs

Table of contents

Personal_Details

Personal Details - Get

Back to top

Get a person's personal details

GET /personal-details/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of account or patient

Examples

Example usage:

curl "https://yourdomain.com/personal-details/<patient-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
email String
picURL String

url of the uploaded photo
name object
name.prefix String
name.firstName String
name.middleName String
name.lastName String
name.suffix String
maidenName object
maidenName.prefix String
maidenName.firstName String
maidenName.middleName String
maidenName.lastName String
maidenName.suffix String
address object
address.street1 String
address.street2 String
address.city String
address.province String
address.country String
dateOfBirth Number

timestamp of the date of birth
sex String

male

 female</p>
maritalStatus String

single

 married widow widower</p>
nationality String
religion String
bloodType String
height Number
weight Number
deceased Number

timestamp of the date of death
mobileNo String
homeNo String
workNo String
emergencyNo String
emergencyContactName String
emergencyContactRelationship String
emergencyContactMobileNo String
fathersName String
fathersMobileNo String
fathersReligion String
fathersNationality String
mothersName String
mothersMobileNo String
mothersReligion String
educations object[]
educations.degree String
educations.school String
educations.from Number

year
educations.to Number

year
insuranceCards object[]
insuranceCards.insurance String

hmo organization id
insuranceCards.insuranceType String

hmo

 government</p>
insuranceCards.number String
insuranceCards.membershipType String
companies Object[]
companies.company String

organization id of the company
companies.externalId String

external company identifier

Use case

  • account id/code in medicard
companies.name String

company name
tags String[]
OSCASeniorCitizenId String
PWDId String
doc_verified Boolean
doc_practicingSince number

unix timestamp
doc_PRCLicenseNo string
doc_PRCLicenseExp string
doc_PTRNumber string
doc_S2Number string
doc_professions string[]
doc_specialties string[]
doc_services string[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "person-id",
  "name": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "sex": "female"
}

Personal Details - Patch

Back to top

Update a persona's personal details

PATCH /personal-details/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of account or patient
personalDetails object

patient's personal details
personalDetails.email object
personalDetails.picURL object

url of the uploaded photo
personalDetails.name object
personalDetails.name.prefix String
personalDetails.name.firstName String
personalDetails.name.middleName String
personalDetails.name.lastName String
personalDetails.name.suffix String
personalDetails.maidenName object
personalDetails.maidenName.prefix String
personalDetails.maidenName.firstName String
personalDetails.maidenName.middleName String
personalDetails.maidenName.lastName String
personalDetails.maidenName.suffix String
personalDetails.address object
personalDetails.address.street1 String
personalDetails.address.street2 String
personalDetails.address.city String
personalDetails.address.province String
personalDetails.address.country String
personalDetails.dateOfBirth Number

timestamp of the date of birth
personalDetails.sex String

male

 female</p>
personalDetails.maritalStatus String

single

 married widow widower</p>
personalDetails.nationality String
personalDetails.religion String
personalDetails.bloodType String
personalDetails.height Number
personalDetails.weight Number
personalDetails.deceased Number

timestamp of the date of death
personalDetails.mobileNo String
personalDetails.homeNo String
personalDetails.workNo String
personalDetails.emergencyNo String
personalDetails.emergencyContactName String
personalDetails.emergencyContactRelationship String
personalDetails.emergencyContactMobileNo String
personalDetails.fathersName String
personalDetails.fathersMobileNo String
personalDetails.fathersReligion String
personalDetails.fathersNationality String
personalDetails.mothersName String
personalDetails.mothersMobileNo String
personalDetails.mothersReligion String
personalDetails.educations object[]
personalDetails.educations.degree String
personalDetails.educations.school String
personalDetails.educations.from Number

year
personalDetails.educations.to Number

year
personalDetails.insuranceCards object[]
personalDetails.insuranceCards.insurance String

hmo organization id
personalDetails.insuranceCards.insuranceType String

hmo

 government</p>
personalDetails.insuranceCards.number String
personalDetails.insuranceCards.membershipType String
personalDetails.companies Object[]
personalDetails.companies.company String

organization id of the company
personalDetails.companies.externalId String

external company identifier

Use case

  • account id/code in medicard
personalDetails.companies.name String

company name

Examples

Example usage:

curl "https://yourdomain.com/personal-details/<patient-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "name": {
      "firstName": "Jane",
      "lastName": "Doe"
    },
    "sex": "female"
  }'

Parameters examples

json - Request-Example

{
  "name": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "sex": "female"
}

Success response

Success response - Success 200

Name Type Description
id string
email String
picURL String

url of the uploaded photo
name object
name.prefix String
name.firstName String
name.middleName String
name.lastName String
name.suffix String
maidenName object
maidenName.prefix String
maidenName.firstName String
maidenName.middleName String
maidenName.lastName String
maidenName.suffix String
address object
address.street1 String
address.street2 String
address.city String
address.province String
address.country String
dateOfBirth Number

timestamp of the date of birth
sex String

male

 female</p>
maritalStatus String

single

 married widow widower</p>
nationality String
religion String
bloodType String
height Number
weight Number
deceased Number

timestamp of the date of death
mobileNo String
homeNo String
workNo String
emergencyNo String
emergencyContactName String
emergencyContactRelationship String
emergencyContactMobileNo String
fathersName String
fathersMobileNo String
fathersReligion String
fathersNationality String
mothersName String
mothersMobileNo String
mothersReligion String
educations object[]
educations.degree String
educations.school String
educations.from Number

year
educations.to Number

year
insuranceCards object[]
insuranceCards.insurance String

hmo organization id
insuranceCards.insuranceType String

hmo

 government</p>
insuranceCards.number String
insuranceCards.membershipType String
companies Object[]
companies.company String

organization id of the company
companies.externalId String

external company identifier

Use case

  • account id/code in medicard
companies.name String

company name
tags String[]
OSCASeniorCitizenId String
PWDId String
doc_verified Boolean
doc_practicingSince number

unix timestamp
doc_PRCLicenseNo string
doc_PRCLicenseExp string
doc_PTRNumber string
doc_S2Number string
doc_professions string[]
doc_specialties string[]
doc_services string[]

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "person-id",
  "name": {
    "firstName": "Jane",
    "lastName": "Doe"
  },
  "sex": "female"
}

results matching ""

    No results matching ""