HDR FHIR API

GET RequestGroup Resource Bundle

get

/oracle-fhir-server/fhir/RequestGroup

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
author(optional): string

The author of the request group
authored(optional): string(date)

The date the request group was authored
code(optional): string

The code of the request group
encounter(optional): string

The encounter the request group applies to
group-identifier(optional): string

The group identifier for the request group
identifier(optional): string

External identifiers for the request group
instantiates-canonical(optional): string

The FHIR-based definition from which the request group is realized
instantiates-uri(optional): string

The external definition from which the request group is realized
intent(optional): string

The intent of the request group
participant(optional): string

The participant in the requests in the group
patient(optional): string

The identity of a patient to search for request groups
priority(optional): string

The priority of the request group
status(optional): string

The status of the request group
subject(optional): string

The subject that the request group is about

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object RequestGroup

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

Nested Schema : RequestGroup

Type: object

Show Source

action: array action

Minimum Number of Items: 1

Unique Items Required: true
author: object Account_coverage
authoredOn: string

Minimum Length: 1
contained: array contained

Minimum Number of Items: 1

Unique Items Required: true
encounter: object Account_coverage
groupIdentifier: object Account_identifier
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
intent: string

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

Minimum Number of Items: 1

Unique Items Required: true
priority: string

Minimum Length: 1
reasonCode: array reasonCode

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "action",
        "author",
        "authoredOn",
        "contained",
        "encounter",
        "groupIdentifier",
        "id",
        "identifier",
        "intent",
        "meta",
        "note",
        "priority",
        "reasonCode",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "contained":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/RequestGroup_contained"
            },
            "minItems":1
        },
        "identifier":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/AuditEvent_who_identifier"
            },
            "minItems":1
        },
        "groupIdentifier":{
            "$ref":"#/definitions/Account_identifier"
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "intent":{
            "type":"string",
            "minLength":1
        },
        "priority":{
            "type":"string",
            "minLength":1
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        },
        "encounter":{
            "$ref":"#/definitions/Account_coverage"
        },
        "authoredOn":{
            "type":"string",
            "minLength":1
        },
        "author":{
            "$ref":"#/definitions/Account_coverage"
        },
        "reasonCode":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "note":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_topic"
            },
            "minItems":1
        },
        "action":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/RequestGroup_action_1"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : action

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object RequestGroup_action_1

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object RequestGroup_contained

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

Nested Schema : Account_identifier

Type: object

Show Source

system: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "value"
    ],
    "properties":{
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "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 : 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 : 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_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 : RequestGroup_action_1

Type: object

Show Source

action(optional): array action

Minimum Number of Items: 1

Unique Items Required: true
cardinalityBehavior: string

Minimum Length: 1
description: string

Minimum Length: 1
groupingBehavior: string

Minimum Length: 1
participant(optional): array participant

Minimum Number of Items: 1

Unique Items Required: true
precheckBehavior: string

Minimum Length: 1
prefix: string

Minimum Length: 1
requiredBehavior: string

Minimum Length: 1
selectionBehavior: string

Minimum Length: 1
textEquivalent: string

Minimum Length: 1
timingDateTime: string

Minimum Length: 1
title: string

Minimum Length: 1

{
    "required":[
        "cardinalityBehavior",
        "description",
        "groupingBehavior",
        "precheckBehavior",
        "prefix",
        "requiredBehavior",
        "selectionBehavior",
        "textEquivalent",
        "timingDateTime",
        "title"
    ],
    "properties":{
        "prefix":{
            "type":"string",
            "minLength":1
        },
        "title":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "textEquivalent":{
            "type":"string",
            "minLength":1
        },
        "timingDateTime":{
            "type":"string",
            "minLength":1
        },
        "participant":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "groupingBehavior":{
            "type":"string",
            "minLength":1
        },
        "selectionBehavior":{
            "type":"string",
            "minLength":1
        },
        "requiredBehavior":{
            "type":"string",
            "minLength":1
        },
        "precheckBehavior":{
            "type":"string",
            "minLength":1
        },
        "cardinalityBehavior":{
            "type":"string",
            "minLength":1
        },
        "action":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/RequestGroup_action"
            },
            "minItems":1
        }
    }
}

Nested Schema : action

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object RequestGroup_action

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

Nested Schema : participant

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

Type: object

Show Source

description: string

Minimum Length: 1
id: string

Minimum Length: 1
relatedAction(optional): array relatedAction

Minimum Number of Items: 1

Unique Items Required: true
resource(optional): object Account_coverage
type(optional): object Claim_priority

{
    "required":[
        "description",
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "minLength":1
        },
        "description":{
            "type":"string",
            "minLength":1
        },
        "relatedAction":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/RequestGroup_relatedAction"
            },
            "minItems":1
        },
        "type":{
            "$ref":"#/definitions/Claim_priority"
        },
        "resource":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : relatedAction

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object RequestGroup_relatedAction

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

Nested Schema : Claim_priority

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/CapabilityStatement_interaction_1"
            },
            "minItems":1
        }
    }
}

Nested Schema : RequestGroup_relatedAction

Type: object

Show Source

actionId: string

Minimum Length: 1
offsetDuration(optional): object MedicationKnowledge_amount
relationship: string

Minimum Length: 1

{
    "required":[
        "actionId",
        "relationship"
    ],
    "properties":{
        "actionId":{
            "type":"string",
            "minLength":1
        },
        "relationship":{
            "type":"string",
            "minLength":1
        },
        "offsetDuration":{
            "$ref":"#/definitions/MedicationKnowledge_amount"
        }
    }
}

Nested Schema : MedicationKnowledge_amount

Type: object

Show Source

unit: string

Minimum Length: 1
value: number

{
    "required":[
        "unit",
        "value"
    ],
    "properties":{
        "value":{
            "type":"number"
        },
        "unit":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : coding

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object CapabilityStatement_interaction_1

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

Nested Schema : CapabilityStatement_interaction_1

Type: object

Show Source

code: string

Minimum Length: 1

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

Nested Schema : RequestGroup_contained

Type: object

Show Source

id: string

Minimum Length: 1
intent: string

Minimum Length: 1
medicationCodeableConcept(optional): object ActivityDefinition_topic
resourceType: string

Minimum Length: 1
status: string

Minimum Length: 1
subject(optional): object Account_coverage

{
    "required":[
        "id",
        "intent",
        "resourceType",
        "status"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "intent":{
            "type":"string",
            "minLength":1
        },
        "medicationCodeableConcept":{
            "$ref":"#/definitions/ActivityDefinition_topic"
        },
        "subject":{
            "$ref":"#/definitions/Account_coverage"
        }
    }
}

Nested Schema : ActivityDefinition_topic

Type: object

Show Source

text: string

Minimum Length: 1

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