Procedures

To define

Supported Formats

json
>>>

GET /api/Procedure
Procedures

Supported Formats

json

Errors

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

Examples

GET /Procedure?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "389a82af8ebbac6be4c0a62b68afb4d6",
  "type": "searchset",
  "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": " "
        },
        "performedDateTime": "2011-10-05",
        "basedOn": [
          {
            "reference": "ServiceRequest/1002"
          }
        ]
      }
    },
    {
      "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": " "
        },
        "performedDateTime": "2015-06-22",
        "basedOn": [
          {
            "reference": "ServiceRequest/1001"
          }
        ]
      }
    }
  ],
  "total": 2
}
GET /Procedure?patient=1&access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
200
{
  "resourceType": "Bundle",
  "id": "eabd3c9174fc1bf0c076b48b2af56b7a",
  "type": "searchset",
  "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": " "
        },
        "performedDateTime": "2011-10-05",
        "basedOn": [
          {
            "reference": "ServiceRequest/1002"
          }
        ]
      }
    },
    {
      "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": " "
        },
        "performedDateTime": "2015-06-22",
        "basedOn": [
          {
            "reference": "ServiceRequest/1001"
          }
        ]
      }
    }
  ],
  "total": 2
}

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.
patient
optional

ID of Patient

Validations:

  • Must be number.
date
optional

Date with optional comparison prefix ('gt2026-02-09T16:19:15-05:00')

Validations:

  • Must be date.
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.
>>>

POST /api/Procedure/_search
Procedures by POST

GET /api/Procedure/:id
Procedure by ID

Supported Formats

json

Errors

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

Examples

GET /Procedure/1001?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": " "
  },
  "performedDateTime": "2015-06-22",
  "basedOn": [
    {
      "reference": "ServiceRequest/1001"
    }
  ]
}
GET /Procedure/1001?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": " "
  },
  "performedDateTime": "2015-06-22",
  "basedOn": [
    {
      "reference": "ServiceRequest/1001"
    }
  ]
}
GET /Procedure/1001?access_token=Pn4p4dV8wKy5p8awLR9CYQRWdsgNYLRxRef5DdYEDt1smi6jkMbfu2Zmp9q3Svkh
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": " "
  },
  "performedDateTime": "2015-06-22",
  "basedOn": [
    {
      "reference": "ServiceRequest/1001"
    }
  ]
}
GET /Procedure/1001
401

Params

Param name Description
access_token
optional

CarePaths User OAuth Token

Validations:

  • Must be String.

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_date_time
required

Validations:

  • Must be String.
based_on
required

Validations:

  • Must be Array.