HDR FHIR API

GET Flag Resource Bundle

get

/oracle-fhir-server/fhir/Flag

This endpoint supports the retrieval of Flag resource list.It returns Bundle of Flag 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

Flag creator
date(optional): string(date)

Time period when flag is active
encounter(optional): string

Alert relevant during encounter
identifier(optional): string

Business identifier
patient(optional): string

The identity of a subject to list flags for
subject(optional): string

The identity of a subject to list flags for

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Flag

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

Nested Schema : Flag

Type: object

Show Source

author: object Account_subject
category: array category

Minimum Number of Items: 1

Unique Items Required: true
code: object Account_type
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
period: object Account_servicePeriod
resourceType: string

Minimum Length: 1
status: string

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

{
    "type":"object",
    "required":[
        "author",
        "category",
        "code",
        "id",
        "identifier",
        "meta",
        "period",
        "resourceType",
        "status",
        "subject",
        "text"
    ],
    "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
        },
        "status":{
            "type":"string",
            "minLength":1
        },
        "category":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Communication_medium"
            },
            "minItems":1
        },
        "code":{
            "$ref":"#/definitions/Account_type"
        },
        "subject":{
            "$ref":"#/definitions/Account_subject"
        },
        "period":{
            "$ref":"#/definitions/Account_servicePeriod"
        },
        "author":{
            "$ref":"#/definitions/Account_subject"
        },
        "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 : category

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Communication_medium

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

Type: object

Show Source

end: string

Minimum Length: 1
start: string

Minimum Length: 1

{
    "required":[
        "end",
        "start"
    ],
    "properties":{
        "start":{
            "type":"string",
            "minLength":1
        },
        "end":{
            "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 : Communication_medium

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true
text: string

Minimum Length: 1

{
    "required":[
        "text"
    ],
    "properties":{
        "coding":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_type_coding"
            },
            "minItems":1
        },
        "text":{
            "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 : 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 : 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
}