Jump to

• Request
• Response

Get a list of procedures

get

/Procedure

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves a list of procedures that meet the supplied query parameters.

• Provide exactly one of _id, patient, or subject.
• Use date only with patient or subject.

Request

Query Parameters

• _count: integer
  Minimum Value: 1

  Maximum Value: 128

  The maximum number of results per page.

  Default Value: 50
• _id: string
  The logical resource ID.
• _lastUpdated: string
  The last updated date or range.
• _revinclude: string
  The inclusion of related Provenance resources whose target is a returned procedure.

  Allowed Values: [ "Provenance:target" ]
• date: string
  The performed date or range.
• patient: string
  The patient logical ID or Patient/id reference.
• subject: string
  Pattern: ^Patient/.+

  The Patient/id subject reference.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• total: integer
  Minimum Value: 0
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleEntryForProcedure"
            }
        },
        "total":{
            "type":"integer",
            "minimum":0
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleEntryForProcedure"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : BundleEntryForProcedure

Type: object

Show Source

• fullUrl(required): string
• resource(required): resource
• search(required): object BundleEntrySearch

{
    "type":"object",
    "required":[
        "fullUrl",
        "resource",
        "search"
    ],
    "additionalProperties":false,
    "properties":{
        "fullUrl":{
            "type":"string"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Procedure"
                },
                {
                    "$ref":"#/components/schemas/ProvenanceForProcedure"
                },
                {
                    "$ref":"#/components/schemas/OperationOutcome"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

• object Procedure
  The US Core Procedure returned by read and search operations.
• object ProvenanceForProcedure
  Additional Properties Allowed: true
• object OperationOutcome
  The FHIR OperationOutcome.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Procedure"
        },
        {
            "$ref":"#/components/schemas/ProvenanceForProcedure"
        },
        {
            "$ref":"#/components/schemas/OperationOutcome"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : Procedure

Type: object

The US Core Procedure returned by read and search operations.

Show Source

• _performedDateTime: object PrimitiveElementForProcedure
• basedOn: array basedOn
• category: object CodeableConceptForProcedure
• code(required): object CodeableConceptForProcedure
• encounter: object ReferenceForProcedure
• extension: array extension
• id(required): string
• location: object ReferenceForProcedure
• meta: object meta
• note: array note
• performedDateTime: string (date-time)
• performedPeriod: object Period
• performer: array performer
• reasonReference: array reasonReference
• recorder: object ReferenceForProcedure
• resourceType(required): string
  Allowed Values: [ "Procedure" ]
• status(required): string
  Allowed Values: [ "completed", "entered-in-error" ]
• subject(required): object ReferenceForProcedure
• text: object Narrative

{
    "type":"object",
    "description":"The US Core Procedure returned by read and search operations.",
    "required":[
        "resourceType",
        "id",
        "status",
        "code",
        "subject"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Procedure"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForProcedure"
            }
        },
        "basedOn":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForProcedure"
            }
        },
        "status":{
            "type":"string",
            "enum":[
                "completed",
                "entered-in-error"
            ]
        },
        "category":{
            "$ref":"#/components/schemas/CodeableConceptForProcedure"
        },
        "code":{
            "$ref":"#/components/schemas/CodeableConceptForProcedure"
        },
        "subject":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        },
        "encounter":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        },
        "performedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "_performedDateTime":{
            "$ref":"#/components/schemas/PrimitiveElementForProcedure"
        },
        "recorder":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PerformerForProcedure"
            }
        },
        "location":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        },
        "reasonReference":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForProcedure"
            }
        },
        "note":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AnnotationForProcedure"
            }
        },
        "performedPeriod":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : ProvenanceForProcedure

Type: object

Additional Properties Allowed: true

Show Source

• resourceType(required): string
  Allowed Values: [ "Provenance" ]

{
    "type":"object",
    "required":[
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : PrimitiveElementForProcedure

Type: object

Show Source

• extension: array extension

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForProcedure"
            }
        }
    }
}

Nested Schema : basedOn

Type: array

Show Source

• Array of: object ReferenceForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForProcedure"
    }
}

Nested Schema : CodeableConceptForProcedure

Type: object

Show Source

• coding: array coding
• extension: array extension
• text: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForProcedure"
            }
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : ReferenceForProcedure

Type: object

Show Source

• display: string
• reference: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForProcedure"
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : note

Type: array

Show Source

• Array of: object AnnotationForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AnnotationForProcedure"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : performer

Type: array

Show Source

• Array of: object PerformerForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PerformerForProcedure"
    }
}

Nested Schema : reasonReference

Type: array

Show Source

• Array of: object ReferenceForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForProcedure"
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForProcedure"
    }
}

Nested Schema : ExtensionForProcedure

Type: object

Show Source

• url(required): string
• valueCode: string
• valueReference: object ReferenceForProcedure

{
    "type":"object",
    "required":[
        "url"
    ],
    "additionalProperties":false,
    "properties":{
        "url":{
            "type":"string"
        },
        "valueCode":{
            "type":"string"
        },
        "valueReference":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForProcedure

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForProcedure"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : AnnotationForProcedure

Type: object

Show Source

• authorReference: object ReferenceForProcedure
• text(required): string
• time: string (date-time)

{
    "type":"object",
    "required":[
        "text"
    ],
    "additionalProperties":false,
    "properties":{
        "authorReference":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        },
        "time":{
            "type":"string",
            "format":"date-time"
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : PerformerForProcedure

Type: object

Show Source

• actor(required): object ReferenceForProcedure
• function: object CodeableConceptForProcedure

{
    "type":"object",
    "required":[
        "actor"
    ],
    "additionalProperties":false,
    "properties":{
        "function":{
            "$ref":"#/components/schemas/CodeableConceptForProcedure"
        },
        "actor":{
            "$ref":"#/components/schemas/ReferenceForProcedure"
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top