Request and Response Formats

Procedures API entry point, responds with all available procedures assigned to your apikey.  This resource does not have any attributes within the url. Instead it offers the initial API affordances (/v1/procedures) in the form of links to available media types.

Procedures API entry point, responds with all available procedures.

This resource does not have any attributes. Instead it offers the initial API affordances in the form of links to available media types.

 
 
What is a Cardiac Catheterization Angiography

What is a Cardiac Catheterization Angiography

EXAMPLE REQUEST

To call the API you can use a command line tool call curl.  We also like to use getpostman.com.

curl 'http://api.medselfed.com/v1/procedures?apikey=111223' 
 

RESPONSE

If your API key is valid and your account has been activated, you will see the following response:

{
  "class": [
    "root"
  ],
  "properties": [
    {
      "id": 477,
      "langId": "en",
      "siteId": "preop",
      "name": "Abdominal Aortic Aneurysm - Open Repair",
      "translations": [],
      "links": [
        {
          "type": "application/json",
          "href": "http://api.medselfed.com/v1/en/procedures/477"
        },
        {
          "type": "image/jpg",
          "href": "http://api.medselfed.com/v1/en/procedures/477/image.jpg"
        },
        {
          "type": "video/mp4",
          "href": "http://api.medselfed.com/v1/en/procedures/477/video.mp4"
        },
        {
          "type": "text/plain",
          "href": "http://api.medselfed.com/v1/en/procedures/477/video.m3u8"
        }
      ]
    },
    {
      "id": 402,
      "langId": "en",
      "siteId": "preop",
      "name": "Abdominal Fibroid Removal - Myomectomy",
      "translations": [],
      "links": [
        {
          "type": "application/json",
          "href": "http://api.medselfed.com/v1/en/procedures/402"
        },
        {
          "type": "image/jpg",
          "href": "http://api.medselfed.com/v1/en/procedures/402/image.jpg"
        },
        {
          "type": "video/mp4",
          "href": "http://api.medselfed.com/v1/en/procedures/402/video.mp4"
        },
        {
          "type": "text/plain",
          "href": "http://api.medselfed.com/v1/en/procedures/402/video.m3u8"
        }
      ]
    }
  ],
  "actions": [],
  "links": [],
  "entities": []
}
 
What is a Permanent Pacemaker Implant

What is a Permanent Pacemaker Implant

GET PROCEDURES BY ID

A single Procedure presentation. This is the central resource in the Procedures API. It represents a single presentation.

The Procedures resource has the following attributes:

  • id

  • location

  • name

  • title

  • string

  • h1

  • h2

Example Request

To make a request to the API run the following command at a terminal prompt

curl 'http://api.medselfed.com/v1/procedures?apikey=111223' 
 

RESPONSE

If your API key is valid and your account has been activated, you will see the following response:

{
  "class": [
    "procedures"
  ],
  "properties": {
    "id": "549-006",
    "langId": "es",
    "location": "online",
    "translations": [
      {
        "langId": "en",
        "name": "Transrectal Ultrasound and Prostate Biopsy",
        "content": "Transrectal Ultrasound and Prostate Biopsy",
        "type": "application/json",
        "href": "http://api.medselfed.com/v1/en/procedures/549-006"
      },
      {
        "langId": "es",
        "name": "Ultrasonido Transrectal y Biopsia de Próstata",
        "content": "Ultrasonido Transrectal y Biopsia de Próstata",
        "type": "application/json",
        "href": "http://api.medselfed.com/v1/es/procedures/549-006"
      }
    ],
    "h1": "Transrectal Ultrasound and Prostate Biopsy",
    "name": "Transrectal Ultrasound and Prostate Biopsy",
    "title": "Transrectal Ultrasound and Prostate Biopsy",
    "string": "Transrectal_Ultrasound_and_Prostate_Biopsy"
  },
  "actions": [],
  "links": [
    {
      "name": "self",
      "type": "application/json",
      "href": "http://api.medselfed.com/v1/es/procedures/549-006"
    },
    {
      "name": "procedure-image-jpg",
      "type": "image/jpg",
      "href": "http://api.medselfed.com/v1/es/procedures/549-006/image.jpg"
    },
    {
      "name": "procedure-video-mp4",
      "type": "video/mp4",
      "href": "http://api.medselfed.com/v1/es/procedures/549-006/video.mp4"
    },
    {
      "type": "text/plain",
      "name": "procedure-hls-video",
      "href": "http://api.medselfed.com/v1/es/procedures/549-006/video.m3u8"
    },
    {
      "name": "get-all-procedures",
      "type": "application/json",
      "href": "http://api.medselfed.com/v1/es/procedures"
    }
  ],
  "entities": []
}