Update Practitioner Resource - OnyeOne Documentation

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Path Params

practitioner_id

string

required

Body Params application/json

name

object

optional

first_name

string

required

last_name

string

required

title

string

optional

telecom

array [object {2}]

optional

phone

string

optional

email

string

optional

address

object

optional

line

string

optional

city

string

optional

state

string

optional

postal_code

string

optional

country

string

optional

gender

enum<string>

optional

Allowed values:

malefemaleotherunknown

active

boolean

optional

birth_date

string

optional

Date in YYYY-MM-DD format.

qualification

array [object {3}]

optional

code

string

required

See http://terminology.hl7.org/CodeSystem/v2-0360 for value sets

name

string

required

See http://terminology.hl7.org/CodeSystem/v2-0360 for associated names

period

object

optional

Period during which the qualification is valid, if applicable.

Example

{
    "name": {
        "first_name": "Zaria",
        "last_name": "Treutel",
        "title": "Dr"
    },
    "telecom": [
        {
            "phone": "(475) 711-5585",
            "email": "Jaydon78@yahoo.com"
        },
        {
            "phone": "(626) 871-4173",
            "email": "Toy.Smith@yahoo.com"
        }
    ],
    "address": {
        "line": "Ut",
        "city": "West Patienceside",
        "state": "Nebraska",
        "postal_code": "39849",
        "country": "Latvia"
    },
    "gender": "female",
    "marital_status": "Divorced"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://staging.onyeone.com/api/emr/practitioner/' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "name": {
        "first_name": "Zaria",
        "last_name": "Treutel",
        "title": "Dr"
    },
    "telecom": [
        {
            "phone": "(475) 711-5585",
            "email": "Jaydon78@yahoo.com"
        },
        {
            "phone": "(626) 871-4173",
            "email": "Toy.Smith@yahoo.com"
        }
    ],
    "address": {
        "line": "Ut",
        "city": "West Patienceside",
        "state": "Nebraska",
        "postal_code": "39849",
        "country": "Latvia"
    },
    "gender": "female",
    "marital_status": "Divorced"
}'

Responses

🟢200Success

application/json

Body

message

string

required

resource_name

string

required

resource_id

string

required

full_resource

object

required

resourceType

string

required

id

string

required

meta

object

required

active

boolean

required

name

array [object {3}]

required

telecom

array [object {3}]

required

address

array [object {5}]

required

birthDate

string

optional

qualification

array [object {2}]

optional

Example

{
    "message": "Resource created successfully",
    "resource_name": "Practitioner",
    "resource_id": "7846cd35-2185-57a5-82a2-1ec66f985448",
    "full_resource": {
        "resourceType": "Practitioner",
        "id": "7846cd35-2185-57a5-82a2-1ec66f985448",
        "meta": {
            "versionId": "1",
            "lastUpdated": "2024-12-18T10:44:53.587+00:00",
            "source": "#UU291R6Ch5mDVmqd",
            "tag": [
                {
                    "system": "http://onyeone.com/facility-tags/origination",
                    "code": "1",
                    "display": "Green Group Hospital"
                }
            ]
        },
        "active": true,
        "name": [
            {
                "family": "Treutel",
                "given": [
                    "Zaria"
                ],
                "prefix": [
                    "Dr"
                ]
            }
        ],
        "telecom": [
            {
                "system": "phone",
                "value": "+1234356756",
                "use": "work"
            },
            {
                "system": "email",
                "value": "Jaydon78@yahoo.com",
                "use": "work"
            },
            {
                "system": "phone",
                "value": "+1234356578",
                "use": "work"
            },
            {
                "system": "email",
                "value": "Jaydon78@yahoo.com",
                "use": "work"
            }
        ],
        "address": [
            {
                "line": [
                    "Ut"
                ],
                "city": "West Patienceside",
                "state": "Nebraska",
                "postalCode": "39849",
                "country": "Latvia"
            }
        ],
        "birthDate": "1990-01-28",
        "qualification": [
            {
                "code": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
                            "code": "CANP",
                            "display": "Certified Adult Nurse Practitioner"
                        }
                    ],
                    "text": "Certified Adult Nurse Practitioner"
                }
            },
            {
                "code": {
                    "coding": [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v2-0360",
                            "code": "CNM",
                            "display": "Certified Nurse Midwife"
                        }
                    ],
                    "text": "Certified Nurse Midwife"
                },
                "period": {
                    "start": "2018-10-17",
                    "end": "2026-10-16"
                }
            }
        ]
    }
}