Skip to main content

Family Group

Family Group API.

The following endpoints should be made available, in order to enable the possibility to manage appointments, studies, etc. for the patient's family group in Osana's Platform.

GET /patients/{id}/family_group​

Returns family group information for a specified patient.

URI Parameters​

  • id: Patient's ID

Response:​

Code 200
{
    "family_group":[
     {
            "id" : "a6264bad-ed85-4b7f-a428-03787f9383e2",
            "related_patient_id": "gdf452835-fbd8-423a-8746-46069edbhh23",
     "relationship_code": 2,
             "relationship_description": "mother",
             "active": true
       }
       ]
}

POST /patients/{id}/family_group​

Adds a family group member to a patient.

URI Parameters​

  • id: Patient's ID
Body
 {
           "related_patient_id": "gdf452835-fbd8-423a-8746-46069edbhh23",
     "relationship_code": 2,
             "relationship_description": "mother",
             "active": true
}

Response:​

Code 201
{}

Delete /patients/{id}/family_group/{family_group_member_id}​

Removes a family group member from a patient.

URI Parameters​

  • id: Patient's ID
  • family_group_member_id: Family group's member Id

Response:​

Code 200
{}