HDR FHIR API

GET Procedure Resource Bundle

get

/oracle-fhir-server/fhir/Procedure

This endpoint supports the retrieval of Procedure resource list.It returns Bundle of Procedure resource.

Request

Query Parameters

_format(optional): string
_id(optional): string

The ID of the resource
_language(optional): string

The language of the resource
based-on(optional): string

A request for this procedure
category(optional): string

Classification of the procedure
code(optional): string

A code to identify a procedure
date(optional): string(date)

When the procedure was performed
encounter(optional): string

Encounter created as part of
identifier(optional): string

A unique identifier for a procedure
instantiates-canonical(optional): string

Instantiates FHIR protocol or definition
instantiates-uri(optional): string

Instantiates external protocol or definition
location(optional): string

Where the procedure happened
part-of(optional): string

Part of referenced event
patient(optional): string

Search by subject - a patient
performer(optional): string

The reference to the practitioner
reason-code(optional): string

Coded reason procedure performed
reason-reference(optional): string

The justification that the procedure was performed
status(optional): string

preparation | in-progress | not-done | suspended | aborted | completed | entered-in-error | unknown
subject(optional): string

Search by subject

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Procedure

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Procedure"
    }
}

Nested Schema : Procedure

Type: object

Show Source

asserter: object Account_subject
code: object Account_type
followUp: array followUp

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
meta: object Account_meta
note: array note

Minimum Number of Items: 1

Unique Items Required: true
performedDateTime: string

Minimum Length: 1
performer: array performer

Minimum Number of Items: 1

Unique Items Required: true
reasonCode: array reasonCode

Minimum Number of Items: 1

Unique Items Required: true
recorder: object Account_subject
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject: object Account_coverage
text: object Account_text

{
    "type":"object",
    "required":[
        "asserter",
        "code",
        "followUp",
        "id",
        "meta",
        "note",
        "performedDateTime",
        "performer",
        "reasonCode",
        "recorder",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "$ref":"#/definitions/Account_type"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "performedDateTime":{
            "type":"string",
            "minLength":1
        },
        "recorder":{
            "$ref":"#/definitions/Account_subject"
        },
        "asserter":{
            "$ref":"#/definitions/Account_subject"
        },
        "performer":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Procedure_performer"
            },
            "minItems":1
        },
        "reasonCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "followUp":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "note":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : Account_subject

Type: object

Show Source

display: string

Minimum Length: 1
reference: string

Minimum Length: 1

{
    "required":[
        "display",
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_type

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "coding",
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : followUp

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_topic"
    },
    "minItems":1
}

Nested Schema : Account_meta

Type: object

Show Source

tag: array tag

Minimum Number of Items: 1

Unique Items Required: true

{
    "required":[
        "tag"
    ],
    "properties":{
        "tag":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        }
    }
}

Nested Schema : note

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_topic"
    },
    "minItems":1
}

Nested Schema : performer

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Procedure_performer

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Procedure_performer"
    },
    "minItems":1
}

Nested Schema : reasonCode

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_topic

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ActivityDefinition_topic"
    },
    "minItems":1
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

{
    "required":[
        "reference"
    ],
    "properties":{
        "reference":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_text

Type: object

Show Source

div: string

Minimum Length: 1
status: string

Minimum Length: 1

{
    "required":[
        "div",
        "status"
    ],
    "properties":{
        "status":{
            "type":"string",
            "minLength":1
        },
        "div":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Account_type_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1
system: string

Minimum Length: 1

{
    "required":[
        "code",
        "display",
        "system"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "code":{
            "type":"string",
            "minLength":1
        },
        "display":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : tag

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_type_coding

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Account_type_coding"
    },
    "minItems":1
}

Nested Schema : Procedure_performer

Type: object

Show Source

actor(optional): object Account_subject

{
    "properties":{
        "actor":{
            "$ref":"#/definitions/Account_subject"
        }
    }
}