HiMS API Documentation

The Procedure resource type identifies procedures performed on a patient, including surgical procedures, diagnostic procedures, endoscopic procedures, biopsies, counseling, personal support services, etc.

The Procedure resource returns data classes and elements defined for Procedures, SDOH Interventions in United States Core Data for Interoperability (USCDI v2). Example API requests for procedure data are shown below:

Get all procedures performed on a patient

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/Procedure?patient={patientId}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Examples:
GET https://fhir-api.hmsfirst.com/r4/Procedure?patient=29355
                    

Find specific procedure by patient ID, code, and date

curl --request GET \
--url 'https://fhir-api.hmsfirst.com/r4/Procedure?patient={patientID}&code={system}|{code}&date={date}' \
--header 'Accept: application/fhir+json' \
--header 'Authorization: Bearer ACCESS_TOKEN'

Example: specific date
GET https://fhir-api.hmsfirst.com/r4/Procedure?patient=29355&code=http://snomed.info/sct|35637008&date=2019-01-14T00:00:00Z

Example: date range
GET https://fhir-api.hmsfirst.com/r4/Procedure?patient=29355&code=http://snomed.info/sct|35637008&&date=ge2019-01-14T00:00:00Z&date=le2022-01-14T00:00:00Z
                    

Response schema

{
  "type": "object",
  "required": [],
  "properties": {
    "resourceType": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "total": {
      "type": "number"
    },
    "link": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "relation": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "entry": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [],
        "properties": {
          "fullUrl": {
            "type": "string"
          },
          "resource": {
            "type": "object",
            "required": [],
            "properties": {
              "resourceType": {
                "type": "string"
              },
              "id": {
                "type": "string"
              },
              "meta": {
                "type": "object",
                "required": [],
                "properties": {
                  "versionId": {
                    "type": "string"
                  },
                  "lastUpdated": {
                    "type": "string"
                  },
                  "profile": {
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  }
                }
              },
              "status": {
                "type": "string"
              },
              "code": {
                "type": "object",
                "required": [],
                "properties": {
                  "coding": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [],
                      "properties": {
                        "system": {
                          "type": "string"
                        },
                        "code": {
                          "type": "string"
                        },
                        "display": {
                          "type": "string"
                        }
                      }
                    }
                  },
                  "text": {
                    "type": "string"
                  }
                }
              },
              "subject": {
                "type": "object",
                "required": [],
                "properties": {
                  "reference": {
                    "type": "string"
                  }
                }
              },
              "performedDateTime": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}