Update a clinic-visible patient - HMIS Documentation

Update a clinic-visible patient

curl --request PATCH \
  --url https://jaliprohmis.derrickmugabwa.dev/api/v1/patients/{patient} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "identity_type": "<string>",
  "identity_number": "<string>",
  "phone": "<string>",
  "secondary_phone": "<string>",
  "email": "jsmith@example.com",
  "address": "<string>",
  "city": "<string>",
  "county": "<string>",
  "country": "<string>",
  "next_of_kin_name": "<string>",
  "next_of_kin_relationship": "<string>",
  "next_of_kin_phone": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    middle_name: '<string>',
    last_name: '<string>',
    date_of_birth: '2023-12-25',
    identity_type: '<string>',
    identity_number: '<string>',
    phone: '<string>',
    secondary_phone: '<string>',
    email: 'jsmith@example.com',
    address: '<string>',
    city: '<string>',
    county: '<string>',
    country: '<string>',
    next_of_kin_name: '<string>',
    next_of_kin_relationship: '<string>',
    next_of_kin_phone: '<string>'
  })
};

fetch('https://jaliprohmis.derrickmugabwa.dev/api/v1/patients/{patient}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://jaliprohmis.derrickmugabwa.dev/api/v1/patients/{patient}"

payload = {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "identity_type": "<string>",
    "identity_number": "<string>",
    "phone": "<string>",
    "secondary_phone": "<string>",
    "email": "jsmith@example.com",
    "address": "<string>",
    "city": "<string>",
    "county": "<string>",
    "country": "<string>",
    "next_of_kin_name": "<string>",
    "next_of_kin_relationship": "<string>",
    "next_of_kin_phone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "data": {}
}

PATCH

/

patients

/

{patient}

Update a clinic-visible patient

curl --request PATCH \
  --url https://jaliprohmis.derrickmugabwa.dev/api/v1/patients/{patient} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "middle_name": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "identity_type": "<string>",
  "identity_number": "<string>",
  "phone": "<string>",
  "secondary_phone": "<string>",
  "email": "jsmith@example.com",
  "address": "<string>",
  "city": "<string>",
  "county": "<string>",
  "country": "<string>",
  "next_of_kin_name": "<string>",
  "next_of_kin_relationship": "<string>",
  "next_of_kin_phone": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    middle_name: '<string>',
    last_name: '<string>',
    date_of_birth: '2023-12-25',
    identity_type: '<string>',
    identity_number: '<string>',
    phone: '<string>',
    secondary_phone: '<string>',
    email: 'jsmith@example.com',
    address: '<string>',
    city: '<string>',
    county: '<string>',
    country: '<string>',
    next_of_kin_name: '<string>',
    next_of_kin_relationship: '<string>',
    next_of_kin_phone: '<string>'
  })
};

fetch('https://jaliprohmis.derrickmugabwa.dev/api/v1/patients/{patient}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://jaliprohmis.derrickmugabwa.dev/api/v1/patients/{patient}"

payload = {
    "first_name": "<string>",
    "middle_name": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "identity_type": "<string>",
    "identity_number": "<string>",
    "phone": "<string>",
    "secondary_phone": "<string>",
    "email": "jsmith@example.com",
    "address": "<string>",
    "city": "<string>",
    "county": "<string>",
    "country": "<string>",
    "next_of_kin_name": "<string>",
    "next_of_kin_relationship": "<string>",
    "next_of_kin_phone": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "data": {}
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

patient

integer

required

Body

application/json

Partial patient update. clinic_id is not accepted.

first_name

string

Maximum string length: 100

middle_name

string | null

Maximum string length: 100

last_name

string

Maximum string length: 100

sex

enum<string>

Available options:

female,

male,

intersex,

unknown

date_of_birth

string<date> | null

identity_type

string | null

Maximum string length: 50

identity_number

string | null

Maximum string length: 100

phone

string

Maximum string length: 50

secondary_phone

string | null

Maximum string length: 50

email

string<email> | null

Maximum string length: 255

address

string | null

Maximum string length: 500

city

string | null

Maximum string length: 100

county

string | null

Maximum string length: 100

country

string | null

Maximum string length: 100

next_of_kin_name

string | null

Maximum string length: 255

next_of_kin_relationship

string | null

Maximum string length: 100

next_of_kin_phone

string | null

Maximum string length: 50

status

enum<string>

Available options:

active,

inactive,

deceased

Response

Resource returned.

data

object

⌘I