Create Appointment Resource

Testing

Testing Env

https://staging.onyeone.com/api

POST

/emr/appointment

A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s).

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Body Params application/json

Example

{
    "status": "waitlist",
    "participant": [
        {
            "type": "Emergency",
            "actor": {
                "type": "patient",
                "id": "364bf61f-d0ac-3b9a-d91c-dbc2d9d9f46f"
            },
            "required": false,
            "status": "declined",
            "period": {
                "start": "2025-01-03",
                "end": "2025-01-08"
            }
        }
    ],
    "reason_reference": [],
    "reason_code": [
        {
            "code": "122003",
            "name": "Choroidal hemorrhage"
        },
        {
            "code": "409002",
            "name": "Food allergy diet"
        }
    ],
    "description": "Lorem ipsum...",
    "start": "2025-02-07T13:28:17.239+02:00",
    "end": "2025-02-07T17:30:17.239+02:00",
    "minutes_duration": 30,
    "slot": [],
    "comment": "id ex",
    "patient_instruction": "esse ad elit qui",
    "based_on": [],
    "requested_period": [
        {
            "start": "2025-01-02",
            "end": "2025-01-10"
        },
        {
            "start": "2025-01-20",
            "end": "2025-01-30"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://staging.onyeone.com/api/emr/appointment' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status": "waitlist",
    "participant": [
        {
            "type": "Emergency",
            "actor": {
                "type": "patient",
                "id": "364bf61f-d0ac-3b9a-d91c-dbc2d9d9f46f"
            },
            "required": false,
            "status": "declined",
            "period": {
                "start": "2025-01-03",
                "end": "2025-01-08"
            }
        }
    ],
    "reason_reference": [],
    "reason_code": [
        {
            "code": "122003",
            "name": "Choroidal hemorrhage"
        },
        {
            "code": "409002",
            "name": "Food allergy diet"
        }
    ],
    "description": "Lorem ipsum...",
    "start": "2025-02-07T13:28:17.239+02:00",
    "end": "2025-02-07T17:30:17.239+02:00",
    "minutes_duration": 30,
    "slot": [],
    "comment": "id ex",
    "patient_instruction": "esse ad elit qui",
    "based_on": [],
    "requested_period": [
        {
            "start": "2025-01-02",
            "end": "2025-01-10"
        },
        {
            "start": "2025-01-20",
            "end": "2025-01-30"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "message": "Resource created successfully",
    "resource_name": "Appointment",
    "resource_id": "339d4678-8482-5d81-b000-346edfd86484",
    "full_resource": {
        "resourceType": "Appointment",
        "id": "339d4678-8482-5d81-b000-346edfd86484",
        "meta": {
            "versionId": "1",
            "lastUpdated": "2024-12-30T10:18:02.887+00:00",
            "source": "#iQanb40TgsOn9K5M",
            "tag": [
                {
                    "system": "http://onyeone.com/facility-tags/origination",
                    "code": "1",
                    "display": "Green Group Hospital"
                }
            ]
        },
        "status": "waitlist",
        "reasonCode": [
            {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/ValueSet/encounter-reason",
                        "code": "122003",
                        "display": "Choroidal hemorrhage"
                    }
                ],
                "text": "Choroidal hemorrhage"
            },
            {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/ValueSet/encounter-reason",
                        "code": "409002",
                        "display": "Food allergy diet"
                    }
                ],
                "text": "Food allergy diet"
            }
        ],
        "description": "Lorem ipsum...",
        "start": "2025-02-07T13:28:17.239+02:00",
        "end": "2025-02-07T17:30:17.239+02:00",
        "minutesDuration": 30,
        "comment": "id ex",
        "patientInstruction": "esse ad elit qui",
        "participant": [
            {
                "type": [
                    {
                        "coding": [
                            {
                                "system": "http://hl7.org/fhir/participant-type",
                                "code": "emergency",
                                "display": "Emergency"
                            }
                        ],
                        "text": "Emergency"
                    }
                ],
                "actor": {
                    "reference": "Patient/364bf61f-d0ac-3b9a-d91c-dbc2d9d9f46f"
                },
                "status": "declined",
                "period": {
                    "start": "2025-01-03",
                    "end": "2025-01-08"
                }
            }
        ],
        "requestedPeriod": [
            {
                "start": "2025-01-02",
                "end": "2025-01-10"
            },
            {
                "start": "2025-01-20",
                "end": "2025-01-30"
            }
        ]
    }
}

Modified at 2024-12-30 10:19:44

Update Encounter Resource

Update Appointment Resource