HDR FHIR API

GET SupplyDelivery Resource Bundle

get

/oracle-fhir-server/fhir/SupplyDelivery

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
identifier(optional): string

External identifier
patient(optional): string

Patient for whom the item is supplied
receiver(optional): string

Who collected the Supply
status(optional): string

in-progress | completed | abandoned | entered-in-error
supplier(optional): string

Dispenser

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object SupplyDelivery

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

Nested Schema : SupplyDelivery

Type: object

Show Source

basedOn: array basedOn

Minimum Number of Items: 1

Unique Items Required: true
destination: object AuditEvent_source_observer
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
occurrenceDateTime: string

Minimum Length: 1
partOf: array partOf

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
suppliedItem: object SupplyDelivery_suppliedItem
supplier: object AuditEvent_source_observer
text: object Account_text
type: object ActivityDefinition_code_1

{
    "type":"object",
    "required":[
        "basedOn",
        "destination",
        "id",
        "identifier",
        "meta",
        "occurrenceDateTime",
        "partOf",
        "resourceType",
        "status",
        "suppliedItem",
        "supplier",
        "text",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_who_identifier"
            },
            "minItems":1
        },
        "basedOn":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "partOf":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_source_observer"
            },
            "minItems":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/ActivityDefinition_code_1"
        },
        "suppliedItem":{
            "$ref":"#/definitions/SupplyDelivery_suppliedItem"
        },
        "occurrenceDateTime":{
            "type":"string",
            "minLength":1
        },
        "supplier":{
            "$ref":"#/definitions/AuditEvent_source_observer"
        },
        "destination":{
            "$ref":"#/definitions/AuditEvent_source_observer"
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : basedOn

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_coverage

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

Nested Schema : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

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

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_who_identifier

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/AuditEvent_who_identifier"
    },
    "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 : partOf

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object AuditEvent_source_observer

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

Nested Schema : SupplyDelivery_suppliedItem

Type: object

Show Source

itemCodeableConcept: object ChargeItem_code
quantity: object ChargeItem_quantity

{
    "required":[
        "itemCodeableConcept",
        "quantity"
    ],
    "properties":{
        "quantity":{
            "$ref":"#/definitions/ChargeItem_quantity"
        },
        "itemCodeableConcept":{
            "$ref":"#/definitions/ChargeItem_code"
        }
    }
}

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 : ActivityDefinition_code_1

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/ActivityDefinition_code"
            },
            "minItems":1
        },
        "text":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Nested Schema : AuditEvent_who_identifier

Type: object

Show Source

value: string

Minimum Length: 1

{
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "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 : 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 : ChargeItem_code

Type: object

Show Source

coding: array coding

Minimum Number of Items: 1

Unique Items Required: true

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

Nested Schema : ChargeItem_quantity

Type: object

Show Source

value: number

{
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Appointment_coding

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

Nested Schema : Appointment_coding

Type: object

Show Source

code: string

Minimum Length: 1
display: string

Minimum Length: 1

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

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_code

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

Nested Schema : ActivityDefinition_code

Type: object

Show Source

code: string

Minimum Length: 1
system: string

Minimum Length: 1

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