Procedures

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Examples

GET /Procedure?patient=1&access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Bundle",
  "id": "01ad691b24ae11908fdb4d5b465bea13",
  "type": "search set",
  "entry": [
    {
      "full_url": "/Procedure/1002",
      "resource": {
        "resourceType": "Procedure",
        "id": "1002",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
          ]
        },
        "status": "completed",
        "code": {
          "coding": [
            {
              "system": "http://www.ama-assn.org/go/cpt",
              "code": "175135009",
              "display": "Introduction of cardiac pacemaker via vein (procedure)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": " "
        },
        "performedPeriod": {
          "start": "2011-10-05",
          "end": "2011-10-05"
        }
      }
    },
    {
      "full_url": "/Procedure/1001",
      "resource": {
        "resourceType": "Procedure",
        "id": "1001",
        "meta": {
          "versionId": "1",
          "lastUpdated": "2021-03-23T19:36:17.299+00:00",
          "source": "#E1VolYkq84D3M96u",
          "profile": [
            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
          ]
        },
        "status": "completed",
        "code": {
          "coding": [
            {
              "system": "http://www.ama-assn.org/go/cpt",
              "code": "56251003",
              "display": "Nebulizer therapy (procedure)"
            }
          ]
        },
        "subject": {
          "reference": "Patient/1",
          "display": " "
        },
        "performedPeriod": {
          "start": "2015-06-22",
          "end": "2015-06-22"
        }
      }
    }
  ],
  "total": 2
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
patient optional	ID of the requested patient Validations: Must be number.
date optional	Date of Observation with optional prefix in the form of two letters i.e. lt/gt/le/ge Validations: Must be string.
start_date optional	Start date for dataset; Format YYYY-MM-DD Validations: Must be Date.
end_date optional	End date for dataset; Format YYYY-MM-DD Validations: Must be Date.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Bundle Validations: Must be String.
type required	Validations: Must be String.

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Examples

GET /Procedure/1001?access_token=6b5h9crwD1EP2zzNDifB5GNZi1rgmU3vmjsdJE9G9BfhQUL3Pm7stAUvJCgwSbAb
200
{
  "resourceType": "Procedure",
  "id": "1001",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2021-03-23T19:36:17.299+00:00",
    "source": "#E1VolYkq84D3M96u",
    "profile": [
      "http://hl7.org/fhir/us/core/StructureDefinition/us-core-procedure"
    ]
  },
  "status": "completed",
  "code": {
    "coding": [
      {
        "system": "http://www.ama-assn.org/go/cpt",
        "code": "56251003",
        "display": "Nebulizer therapy (procedure)"
      }
    ]
  },
  "subject": {
    "reference": "Patient/1",
    "display": " "
  },
  "performedPeriod": {
    "start": "2015-06-22",
    "end": "2015-06-22"
  }
}

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
id optional	ID of requested procedure Validations: Must be number.

Returns

Code: 200

Description:

List of resources

Param name	Description
resource_type required	Procedure Validations: Must be String.
status required	Validations: Must be String.
code required	Validations: Must be Hash.
subject required	Validations: Must be Hash.
performed_period required	Validations: Must be Hash.

Supported Formats

json

Errors

Code	Description
401	Unauthorized
500	Server crashed for some <%= reason %>

Params

Param name	Description
access_token required	CarePaths User OAuth Token Validations: Must be String.
patient optional	ID of the requested patient Validations: Must be number.
date optional	Date of Observation with optional prefix in the form of two letters i.e. lt/gt/le/ge Validations: Must be string.
start_date optional	Start date for dataset; Format YYYY-MM-DD Validations: Must be Date.
end_date optional	End date for dataset; Format YYYY-MM-DD Validations: Must be Date.