api-docs v5.116.0

API Docs

Table of contents

Medical_Patient

Patient - Find

Back to top

Fetch the list of medical patients registered in the database

GET /medical-patients

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>"
}

Examples

Example usage:

curl "https://yourdomain.com/medical-patients" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
medicalPatients Object[]

array of medical patient
medicalPatients.id String

patient's id
medicalPatients.ref String

external reference for a patient
medicalPatients.facility String

id of the parent facility of the patient
medicalPatients.createdAt Number

timestamp of date of creation
medicalPatients.createdBy String

uid of the user who created the patient profile
medicalPatients.archivedAt Number

timestamp of date of archival
medicalPatients.archivedBy String

uid of the user who archived the patient profile
medicalPatients.lastVisitAt Number

timestamp of the last encounter (visit) of the patient

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "patient-1-id",
    "facility": "your-facility-id",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  },
  {
    "id": "patient-2-id",
    "facility": "your-facility-id",
    "createdAt": 1564661697125,
    "createdBy": "some-uid"
  }
]

Patient - Get

Back to top

Get a specific patient

GET /medical-patients/: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 patient

Examples

Example usage:

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

Success response

Success response - Success 200

Name Type Description
id String

patient's id
ref String

external reference for a patient
facility String

id of the parent facility of the patient
createdAt Number

timestamp of date of creation
createdBy String

uid of the user who created the patient profile
archivedAt Number

timestamp of date of archival
archivedBy String

uid of the user who archived the patient profile
lastVisitAt Number

timestamp of the last encounter (visit) of the patient

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "patient-1-id",
  "facility": "your-facility-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

Patient - Post

Back to top

Create/Register a medical patient

POST /medical-patients

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
facility string

id of the parent facility of the patient
personalDetails Object

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

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.company String
personalDetails.companyPosition String
personalDetails.companyAddress 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.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
personalDetails.tags String[]
personalDetails.OSCASeniorCitizenId String
personalDetails.PWDId String

Examples

Example usage:

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

Parameters examples

json - Request-Example

{
  "facility": "your-facility-id",
  "personalDetails": {
    "name": {
      "firstName": "Jane",
      "lastName": "Doe"
    },
    "sex": "female"
  }
}

Success response

Success response - Success 200

Name Type Description
id String

patient's id
ref String

external reference for a patient
facility String

id of the parent facility of the patient
createdAt Number

timestamp of date of creation
createdBy String

uid of the user who created the patient profile
archivedAt Number

timestamp of date of archival
archivedBy String

uid of the user who archived the patient profile
lastVisitAt Number

timestamp of the last encounter (visit) of the patient

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "patient-1-id",
  "facility": "your-facility-id",
  "createdAt": 1564661697125,
  "createdBy": "some-uid"
}

results matching ""

    No results matching ""