Create Health Service Resource - OnyeOne Documentation

The HealthcareService resource is used to describe a single healthcare service or category of services that are provided by an organization at a location.
The location of the services could be virtual, as with telemedicine services.

Common examples of HealthcareServices resources are:

Allied Health

Clinical Neuropsychologist

Podiatry Service

Smallville Hospital Emergency Services

Respite care provided at a nursing home or hostel

24hr crisis telephone counseling service

Information, advice and/or referral services; Disability, Telecommunications

Rural TeleHealth Services

Hospital in the home

Yellow Cabs

Pharmacy

Active Rehab

Social Support

Drug and/or alcohol counseling

Day Programs, Adult Training & Support Services

Consulting psychologists and/or psychology services

Group Hydrotherapy

Little River Home Maintenance

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Body Params application/json

Example

{
    "active": true,
    "name": "Gerald Koch",
    "location": [
        "d0f2ff01-9bc3-5652-87cf-428d1b3f3170"
    ],
    "telecom": [
        {
            "phone": "+1234654328",
            "email": "Sid.VonRueden3@hotmail.com"
        },
        {
            "phone": "+1234986745",
            "email": "Candido_Nader54@gmail.com"
        }
    ],
    "coverage_area": [
        "d0f2ff01-9bc3-5652-87cf-428d1b3f3170"
    ],
    "appointment_required": true,
    "available_times": [
        {
            "days_of_week": [
                "wed",
                "thu",
                "fri"
            ],
            "all_day": true
        },
        {
            "days_of_week": [
                "mon",
                "tue",
                "sun"
            ],
            "all_day": true
        },
        {
            "days_of_week": [
                "tue",
                "tue",
                "fri"
            ],
            "all_day": false,
            "start_time": "12:00:00",
            "end_time": "17:00:00"
            
        }
    ],
    "not_available_times": [
        {
            "description": "Depono vado adipisci adflicto tantillus tyrannus accusamus delibero. Arbor curia subiungo carmen congregatio tertius vesco. Coma amplexus delectus vitiosus denuncio officiis auctus umerus.",
            "start_date": "2024-03-06",
            "end_date": "2025-01-06"
        },
        {
            "description": "Sonitus abutor ceno pariatur tribuo adeptio cogo. Tristis ipsam adopto aggero beneficium titulus canis una viscus cultura. Libero attollo maxime summisse vilitas advenio amitto quaerat ab accommodo.",
            "start_date": "2024-05-23",
            "end_date": "2025-05-10"
        }
    ],
    "availability_exceptions": "dolor Ut in",
    "comment": "mollit amet velit",
    "extra_details": "qui sit laborum mollit",
    "specialties": [
        {
            "code": "394586005",
            "name": "Gynecology"
        }
        
    ],
    "type": [
        {
            "code": "263",
            "name": "Birth"
        },
        {
            "code": "52",
            "name": "Chiropractic"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://staging.onyeone.com/api/emr/healthcareservice' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "active": true,
    "name": "Gerald Koch",
    "location": [
        "d0f2ff01-9bc3-5652-87cf-428d1b3f3170"
    ],
    "telecom": [
        {
            "phone": "+1234654328",
            "email": "Sid.VonRueden3@hotmail.com"
        },
        {
            "phone": "+1234986745",
            "email": "Candido_Nader54@gmail.com"
        }
    ],
    "coverage_area": [
        "d0f2ff01-9bc3-5652-87cf-428d1b3f3170"
    ],
    "appointment_required": true,
    "available_times": [
        {
            "days_of_week": [
                "wed",
                "thu",
                "fri"
            ],
            "all_day": true
        },
        {
            "days_of_week": [
                "mon",
                "tue",
                "sun"
            ],
            "all_day": true
        },
        {
            "days_of_week": [
                "tue",
                "tue",
                "fri"
            ],
            "all_day": false,
            "start_time": "12:00:00",
            "end_time": "17:00:00"
            
        }
    ],
    "not_available_times": [
        {
            "description": "Depono vado adipisci adflicto tantillus tyrannus accusamus delibero. Arbor curia subiungo carmen congregatio tertius vesco. Coma amplexus delectus vitiosus denuncio officiis auctus umerus.",
            "start_date": "2024-03-06",
            "end_date": "2025-01-06"
        },
        {
            "description": "Sonitus abutor ceno pariatur tribuo adeptio cogo. Tristis ipsam adopto aggero beneficium titulus canis una viscus cultura. Libero attollo maxime summisse vilitas advenio amitto quaerat ab accommodo.",
            "start_date": "2024-05-23",
            "end_date": "2025-05-10"
        }
    ],
    "availability_exceptions": "dolor Ut in",
    "comment": "mollit amet velit",
    "extra_details": "qui sit laborum mollit",
    "specialties": [
        {
            "code": "394586005",
            "name": "Gynecology"
        }
        
    ],
    "type": [
        {
            "code": "263",
            "name": "Birth"
        },
        {
            "code": "52",
            "name": "Chiropractic"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "message": "Resource created successfully",
    "resource_name": "HealthcareService",
    "resource_id": "4e4fbc42-ce67-5a60-bfd7-9cedca2f376c",
    "full_resource": {
        "resourceType": "HealthcareService",
        "id": "4e4fbc42-ce67-5a60-bfd7-9cedca2f376c",
        "meta": {
            "versionId": "1",
            "lastUpdated": "2024-12-19T12:10:59.152+00:00",
            "source": "#jPnuT0tB55ihtyiJ",
            "tag": [
                {
                    "system": "http://onyeone.com/facility-tags/origination",
                    "code": "1",
                    "display": "Green Group Hospital"
                }
            ]
        },
        "active": true,
        "providedBy": {
            "reference": "Organization/5abe99ee-0928-546b-93e9-0207ba8a556b",
            "display": "Green Group Hospital"
        },
        "type": [
            {
                "coding": [
                    {
                        "system": "http://example.com/service-type",
                        "code": "263",
                        "display": "Birth"
                    }
                ],
                "text": "Birth"
            },
            {
                "coding": [
                    {
                        "system": "http://example.com/service-type",
                        "code": "52",
                        "display": "Chiropractic"
                    }
                ],
                "text": "Chiropractic"
            }
        ],
        "specialty": [
            {
                "coding": [
                    {
                        "system": "http://hl7.org/fhir/ValueSet/c80-practice-codes",
                        "code": "394586005",
                        "display": "Gynecology"
                    }
                ],
                "text": "Gynecology"
            }
        ],
        "location": [
            {
                "reference": "Location/d0f2ff01-9bc3-5652-87cf-428d1b3f3170"
            }
        ],
        "name": "Gerald Koch",
        "comment": "mollit amet velit",
        "extraDetails": "qui sit laborum mollit",
        "telecom": [
            {
                "system": "phone",
                "value": "+1234654328",
                "use": "work"
            },
            {
                "system": "email",
                "value": "Sid.VonRueden3@hotmail.com",
                "use": "work"
            },
            {
                "system": "phone",
                "value": "+1234986745",
                "use": "work"
            },
            {
                "system": "email",
                "value": "Candido_Nader54@gmail.com",
                "use": "work"
            }
        ],
        "appointmentRequired": true,
        "availableTime": [
            {
                "daysOfWeek": [
                    "wed",
                    "thu",
                    "fri"
                ],
                "allDay": true
            },
            {
                "daysOfWeek": [
                    "mon",
                    "tue",
                    "sun"
                ],
                "allDay": true
            },
            {
                "daysOfWeek": [
                    "tue",
                    "tue",
                    "fri"
                ],
                "allDay": false,
                "availableStartTime": "12:00:00",
                "availableEndTime": "17:00:00"
            }
        ],
        "notAvailable": [
            {
                "description": "Depono vado adipisci adflicto tantillus tyrannus accusamus delibero. Arbor curia subiungo carmen congregatio tertius vesco. Coma amplexus delectus vitiosus denuncio officiis auctus umerus.",
                "during": {
                    "start": "2024-03-06",
                    "end": "2025-01-06"
                }
            },
            {
                "description": "Sonitus abutor ceno pariatur tribuo adeptio cogo. Tristis ipsam adopto aggero beneficium titulus canis una viscus cultura. Libero attollo maxime summisse vilitas advenio amitto quaerat ab accommodo.",
                "during": {
                    "start": "2024-05-23",
                    "end": "2025-05-10"
                }
            }
        ]
    }
}