Create a Location Resource

Testing Env

https://staging.onyeone.com/api

POST

/emr/location

This API creates a Location resource, which represents a physical place where healthcare services are provided. It can include details such as the name, address, type of location, managing organization, and its operational status.

Request

Authorization

Add parameter in header

x-api-key

Example:

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

Body Params application/json

Example

{
    "name": "Ajah Branch",
    "status": "active",
    "mode": "instance",
    "description": "Description of the Location, which helps in finding or referencing the place.",
    "type": [
        {
            "code": "DX",
            "name": "Diagnostics or therapeutics unit"
        }
    ],
    "telecom": [
        {
            "phone": "12328785665",
            "email": "Christa.Luettgen@hotmail.com"
        },
        {
            "phone": "125468799",
            "email": "Virginie34@hotmail.com"
        },
        {
            "phone": "12438979790",
            "email": "Aletha_Stokes91@gmail.com"
        }
    ],
    "address": {
        "line": "cupidatat Ut",
        "city": "Schambergerport",
        "state": "Hawaii",
        "postal_code": "45511-1589",
        "country": "Mozambique"
    },
    "position": {
        "longitude": -170.867,
        "latitude": 27.8364,
        "altitude": 47047833.39611089
    },
    "hours_of_operation": [
        {
            "days_of_week": [
                "fri"
            ],
            "all_day": true
        },
        {
            "days_of_week": [
                "fri",
                "sat"
            ],
            "all_day": false,
            "opening_time": "15:00:00",
            "closing_time": "18:00:00"
        },
        {
            "days_of_week": [
                "sun",
                "sat",
                "tue"
            ],
            "all_day": true
        }
    ]
}

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/location' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "name": "Ajah Branch",
    "status": "active",
    "mode": "instance",
    "description": "Description of the Location, which helps in finding or referencing the place.",
    "type": [
        {
            "code": "DX",
            "name": "Diagnostics or therapeutics unit"
        }
    ],
    "telecom": [
        {
            "phone": "12328785665",
            "email": "Christa.Luettgen@hotmail.com"
        },
        {
            "phone": "125468799",
            "email": "Virginie34@hotmail.com"
        },
        {
            "phone": "12438979790",
            "email": "Aletha_Stokes91@gmail.com"
        }
    ],
    "address": {
        "line": "cupidatat Ut",
        "city": "Schambergerport",
        "state": "Hawaii",
        "postal_code": "45511-1589",
        "country": "Mozambique"
    },
    "position": {
        "longitude": -170.867,
        "latitude": 27.8364,
        "altitude": 47047833.39611089
    },
    "hours_of_operation": [
        {
            "days_of_week": [
                "fri"
            ],
            "all_day": true
        },
        {
            "days_of_week": [
                "fri",
                "sat"
            ],
            "all_day": false,
            "opening_time": "15:00:00",
            "closing_time": "18:00:00"
        },
        {
            "days_of_week": [
                "sun",
                "sat",
                "tue"
            ],
            "all_day": true
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
      "message": "Resource created successfully",
      "resource_name": "Location",
      "resource_id": "d0f2ff01-9bc3-5652-87cf-428d1b3f3170",
      "full_resource": {
            "resourceType": "Location",
            "id": "d0f2ff01-9bc3-5652-87cf-428d1b3f3170",
            "meta": {
                  "versionId": "1",
                  "lastUpdated": "2024-12-17T14:19:53.241+00:00",
                  "source": "#bosSD8P99I02rFlU",
                  "tag": [
                        {
                              "system": "http://onyeone.com/facility-tags/origination",
                              "code": "1",
                              "display": "Green Group Hospital"
                        }
                  ]
            },
            "status": "active",
            "name": "Ajah Branch",
            "description": "Description of the Location, which helps in finding or referencing the place.",
            "mode": "instance",
            "type": [
                  {
                        "coding": [
                              {
                                    "system": "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType",
                                    "code": "DX",
                                    "display": "Diagnostics or therapeutics unit"
                              }
                        ],
                        "text": "Diagnostics or therapeutics unit"
                  }
            ],
            "telecom": [
                  {
                        "system": "phone",
                        "value": "12328785665",
                        "use": "work"
                  },
                  {
                        "system": "email",
                        "value": "Christa.Luettgen@hotmail.com",
                        "use": "work"
                  },
                  {
                        "system": "phone",
                        "value": "125468799",
                        "use": "work"
                  },
                  {
                        "system": "email",
                        "value": "Virginie34@hotmail.com",
                        "use": "work"
                  },
                  {
                        "system": "phone",
                        "value": "12438979790",
                        "use": "work"
                  },
                  {
                        "system": "email",
                        "value": "Aletha_Stokes91@gmail.com",
                        "use": "work"
                  }
            ],
            "address": {
                  "line": [
                        "cupidatat Ut"
                  ],
                  "city": "Schambergerport",
                  "state": "Hawaii",
                  "postalCode": "45511-1589",
                  "country": "Mozambique"
            },
            "position": {
                  "longitude": -170.867,
                  "latitude": 27.8364,
                  "altitude": 47047833.39611089
            },
            "managingOrganization": {
                  "reference": "Organization/5abe99ee-0928-546b-93e9-0207ba8a556b",
                  "display": "Green Group Hospital"
            },
            "hoursOfOperation": [
                  {
                        "daysOfWeek": [
                              "fri"
                        ],
                        "allDay": true
                  },
                  {
                        "daysOfWeek": [
                              "fri",
                              "sat"
                        ],
                        "allDay": false,
                        "openingTime": "15:00:00",
                        "closingTime": "18:00:00"
                  },
                  {
                        "daysOfWeek": [
                              "sun",
                              "sat",
                              "tue"
                        ],
                        "allDay": true
                  }
            ]
      }
}

Modified at 2025-01-02 12:09:47

Update PractitionerRole Resource

Update Location Resource