api-docs v5.116.0

API Docs

Table of contents

Service

Service - Delete

Back to top

Delete a service's details. Can only delete un-used services.

DELETE /services/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of service

Examples

Example usage:

curl "https://yourdomain.com/services/<service-id>" \
  -X DELETE \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string
  • clinical-consultation,clinical-procedure,diagnostic,pe,dental
subtype string

lab,imaging (for diagnostic type)
ref string

reference id (for lab/imaging tests)
name string
description string
externalId string
specialization Object
specialization.code string
specialization.name string
category string
normalTime number
priceCurrency string
  • PHP
price number
tax number
metadata Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "facility": "facility-id",
  "externalId": "medicard-procedure-code",
  "type": "dental",
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100,
  "metadata": {
    "anyArbitraryKey": "anyArbitraryValue"
  }
}

Service - Get

Back to top

Get a service's details

GET /services/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of service

Examples

Example usage:

curl "https://yourdomain.com/services/<service-id>" \
  -X GET \
  -H "Authorization: Bearer <your-api-token>"

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string
  • clinical-consultation,clinical-procedure,diagnostic,pe,dental
subtype string

lab,imaging (for diagnostic type)
ref string

reference id (for lab/imaging tests)
name string
description string
externalId string
specialization Object
specialization.code string
specialization.name string
category string
normalTime number
priceCurrency string
  • PHP
price number
tax number
metadata Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "facility": "facility-id",
  "externalId": "medicard-procedure-code",
  "type": "dental",
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100,
  "metadata": {
    "anyArbitraryKey": "anyArbitraryValue"
  }
}

Service - Patch

Back to top

Update a service

PATCH /services/:id

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
id string

id of service
name string
description string
externalId string
specialization Object
specialization.code string
specialization.name string
category string
normalTime number
priceCurrency string
  • PHP
price number
tax number
metadata Object

Examples

Example usage:

curl "https://yourdomain.com/services/<service-id>" \
  -X PATCH \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
     "name": "Tooth Extraction",
     "priceCurrency": "PHP",
     "price": 100,
      "metadata": {
        "anyArbitraryKey": "anyArbitraryValue"
      }
  }'

Parameters examples

json - Request-Example

{
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100,
  "metadata": {
    "anyArbitraryKey": "anyArbitraryValue"
  }
}

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string
  • clinical-consultation,clinical-procedure,diagnostic,pe,dental
subtype string

lab,imaging (for diagnostic type)
ref string

reference id (for lab/imaging tests)
name string
description string
externalId string
specialization Object
specialization.code string
specialization.name string
category string
normalTime number
priceCurrency string
  • PHP
price number
tax number
metadata Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "facility": "facility-id",
  "externalId": "medicard-procedure-code",
  "type": "dental",
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100,
  "metadata": {
    "anyArbitraryKey": "anyArbitraryValue"
  }
}

Service - Post

Back to top

Create a service

POST /services

Headers - Header

Name Type Description
Authorization string

key to place the API token to using the grant 'Bearer'

Header examples

Authorization-Example

{
  "Authorization": "Bearer <your-api-token>"
}

Parameters - Parameter

Name Type Description
facility string
type string
  • clinical-consultation,clinical-procedure,diagnostic,pe,dental
subtype string

lab,imaging (for diagnostic type)
ref string

reference id (for lab/imaging tests)
name string
description string
externalId string
specialization Object
specialization.code string
specialization.name string
category string
normalTime number
priceCurrency string
  • PHP
price number
tax number
metadata Object

Examples

Example usage:

curl "https://yourdomain.com/services" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <your-api-token>" \
  -d '{
    "facility": "facility-id",
    "externalId": "medicard-procedure-code",
    "type": "dental",
    "name": "Tooth Extraction",
    "priceCurrency": "PHP",
    "price": 100,
    "metadata": {
      "anyArbitraryKey": "anyArbitraryValue"
    }
  }'

Parameters examples

json - Request-Example

{
  "facility": "facility-id",
  "externalId": "medicard-procedure-code",
  "type": "dental",
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100,
  "metadata": {
    "anyArbitraryKey": "anyArbitraryValue"
  }
}

Success response

Success response - Success 200

Name Type Description
id string
facility string
type string
  • clinical-consultation,clinical-procedure,diagnostic,pe,dental
subtype string

lab,imaging (for diagnostic type)
ref string

reference id (for lab/imaging tests)
name string
description string
externalId string
specialization Object
specialization.code string
specialization.name string
category string
normalTime number
priceCurrency string
  • PHP
price number
tax number
metadata Object

Success response example

Success response example - Success-Response:

HTTP/1.1 200 OK
{
  "id": "service-id",
  "facility": "facility-id",
  "externalId": "medicard-procedure-code",
  "type": "dental",
  "name": "Tooth Extraction",
  "priceCurrency": "PHP",
  "price": 100,
  "metadata": {
    "anyArbitraryKey": "anyArbitraryValue"
  }
}

results matching ""

    No results matching ""