Update Patient Resource - OnyeOne Documentation

This endpoint updates an existing Patient resource. Note that this operation replaces the section in the resource as specified in the body of the request.

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/json

Example

{
    "active": true,
    "name": {
        "first_name": "Kiley",
        "last_name": "Ziemann-Huel",
        "title": "Mr"
    },
    "telecom": [
        {
            "phone": "+1234546798",
            "email": "Carolyn36@yahoo.com"
        }
    ],
    "gender": "other",
    "birth_date": "2025-05-15",
    "deceased": false,
    "address": {
        "line": "exercitation",
        "city": "East Elda",
        "state": "Hawaii",
        "postal_code": "34161-4996",
        "country": "Bulgaria"
    },
    "marital_status": "Polygamous",
    "general_practitioner": [
        "5762e3c4-43ef-5585-9827-177d51c2ed2d"
    ],
    "link": [
        {
            "other": "18ff6238-1f1a-51b3-8a83-04a8492a4fd6",
            "type": "refer"
        }
    ],
    "contact": [
        {
            "relationship": "State Agency",
            "telecom": [
                {
                    "phone": "+1237547468",
                    "email": "Alexandro.Lynch@hotmail.com"
                }
            ],
            "name": {
                "first_name": "Mariela",
                "last_name": "Kunde"
            },
            "address": {
                "line": "nulla",
                "city": "Ilianamouth",
                "state": "Florida",
                "postal_code": "87062",
                "country": "Algeria"
            },
            "gender": "male",
            "period": {
                "start": "2017-02-19",
                "end": "2027-09-24"
            }
        },
        {
            "relationship": "Employer",
            "telecom": [
                {
                    "phone": "+4497598469",
                    "email": "Filomena45@yahoo.com"
                },
                {
                    "phone": "+234565435748",
                    "email": "Madge84@hotmail.com"
                }
            ],
            "name": {
                "first_name": "Preston",
                "last_name": "Waters",
                "title": "Mr"
            },
            "address": {
                "line": "nulla minim",
                "city": "South Kearaville",
                "state": "Vermont",
                "postal_code": "29006-7112",
                "country": "Ireland"
            },
            "gender": "other",
            "period": {
                "start": "2016-09-22",
                "end": "2028-10-13"
            }
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://staging.onyeone.com/api/emr/patient/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "active": true,
    "name": {
        "first_name": "Kiley",
        "last_name": "Ziemann-Huel",
        "title": "Mr"
    },
    "telecom": [
        {
            "phone": "+1234546798",
            "email": "Carolyn36@yahoo.com"
        }
    ],
    "gender": "other",
    "birth_date": "2025-05-15",
    "deceased": false,
    "address": {
        "line": "exercitation",
        "city": "East Elda",
        "state": "Hawaii",
        "postal_code": "34161-4996",
        "country": "Bulgaria"
    },
    "marital_status": "Polygamous",
    "general_practitioner": [
        "5762e3c4-43ef-5585-9827-177d51c2ed2d"
    ],
    "link": [
        {
            "other": "18ff6238-1f1a-51b3-8a83-04a8492a4fd6",
            "type": "refer"
        }
    ],
    "contact": [
        {
            "relationship": "State Agency",
            "telecom": [
                {
                    "phone": "+1237547468",
                    "email": "Alexandro.Lynch@hotmail.com"
                }
            ],
            "name": {
                "first_name": "Mariela",
                "last_name": "Kunde"
            },
            "address": {
                "line": "nulla",
                "city": "Ilianamouth",
                "state": "Florida",
                "postal_code": "87062",
                "country": "Algeria"
            },
            "gender": "male",
            "period": {
                "start": "2017-02-19",
                "end": "2027-09-24"
            }
        },
        {
            "relationship": "Employer",
            "telecom": [
                {
                    "phone": "+4497598469",
                    "email": "Filomena45@yahoo.com"
                },
                {
                    "phone": "+234565435748",
                    "email": "Madge84@hotmail.com"
                }
            ],
            "name": {
                "first_name": "Preston",
                "last_name": "Waters",
                "title": "Mr"
            },
            "address": {
                "line": "nulla minim",
                "city": "South Kearaville",
                "state": "Vermont",
                "postal_code": "29006-7112",
                "country": "Ireland"
            },
            "gender": "other",
            "period": {
                "start": "2016-09-22",
                "end": "2028-10-13"
            }
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "message": "Patient resource updated successfully.",
    "resource_id": "1e9c2550-bd42-5ba5-8ba5-db1e7c945054",
    "updated_fields": {
        "active": true,
        "gender": "male",
        "maritalStatus": {
            "coding": [
                {
                    "code": "M",
                    "display": "Married",
                    "system": "http://terminology.hl7.org/CodeSystem/v3-MaritalStatus"
                }
            ],
            "text": "Married"
        }
    }
}