OnyeOne Documentation
  1. Locations
OnyeOne Documentation
  • Overview
  • OnyeOne Use Cases
  • Authentication
  • Guides
    • OnyeOne Request Flow
  • Core EHR/EMR FHIR R4 APIs
    • Administration
      • Patients
        • Create Patient Resource
        • Update Patient Resource
      • Practitioners
        • Create Practitioner Resource
        • Update Practitioner Resource
        • Create Practitioner Role
        • Update PractitionerRole Resource
      • Locations
        • Create a Location Resource
          POST
        • Update Location Resource
          PUT
      • Health Service
        • Create Health Service Resource
        • Update Health Service Resource
      • Encounters
        • Create Encounter Resource
        • Update Encounter Resource
      • Appointments
        • Create Appointment Resource
        • Update Appointment Resource
      • Group
    • Clinical
      • AllergyIntolerance
      • Condition (Problem)
      • Procedure
      • FamilyMemberHistory
      • CarePlan
      • Goal
      • CareTeam
      • ClinicalImpression
      • AdverseEvent
      • DetectedIssue
      • RiskAssessment
    • Diagnostics
      • Observation
        • Create Observation Resource
      • DiagnosticReport
      • ServiceRequest
      • Media
      • ImagingStudy
      • MolecularSequence
      • Specimen
      • BodyStructure
    • Medications
      • MedicationRequest
      • MedicationDispense
      • MedicationAdministration
      • MedicationStatement
      • Medication
      • MedicationKnowledge
      • Immunization
      • ImmunizationEvaluation
      • ImmunizationRecommendation
    • Financial
      • Account
      • Contract
      • Coverage
      • CoverageEligibilityRequest
      • CoverageEligibilityResponse
      • EnrollmentRequest
      • EnrollmentResponse
      • Claim
      • ClaimResponse
      • PaymentNotice
      • PaymentReconciliation
      • ExplanationOfBenefit
      • VisionPrescription
  • Health Data Transformation
    • Transfrom HL7v2 to FHIR R4
      POST
    • Transform CCDA to FHIR R4
      POST
    • Transform HL7v2 to FHIR R4 and Store in Backend Database
      POST
    • Track API Request
      GET
  • Health Interoperabilty System
    • Create a Subscription
      POST
  • Webhook
  • Get Resource.
    GET
  1. Locations

Update Location Resource

Testing Env
https://staging.onyeone.com/api
Testing Env
https://staging.onyeone.com/api
PUT
/emr/location/{location_id}
emr
This endpoint updates an existing Location 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
location_id
string 
required
Body Params application/json
name
string 
optional
status
enum<string> 
optional
Allowed values:
activesuspendedinactive
mode
enum<string> 
optional
Allowed values:
instancekindvirtual
description
string 
optional
type
array [object {2}] 
optional
code
string 
required
See http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
name
string 
required
Values for code. see http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
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
position
object 
optional
longitude
number 
required
latitude
number 
required
altitude
number 
optional
hours_of_operation
array [object {4}] 
required
days_of_week
array[string]
required
Allowed values:
montuewedthufrisatsun
all_day
boolean 
required
The Location is open all day.
opening_time
string 
optional
closing_time
string 
optional
part_of
string 
optional
ID of another Location of which this Location is physically a part of.
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 samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT '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
message
string 
required
resource_id
string 
required
updated_fields
object 
required
status
string 
optional
Example
{
    "message": "Location resource updated successfully.",
    "resource_id": "d0f2ff01-9bc3-5652-87cf-428d1b3f3170",
    "updated_fields": {
        "status": "suspended"
    }
}
Modified at 2025-01-02 12:09:51
Previous
Create a Location Resource
Next
Create Health Service Resource
Built with