HDR FHIR API

GET Organization Resource Bundle

get

/oracle-fhir-server/fhir/Organization

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
active(optional): string

Is the Organization record active
address(optional): string

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
address-city(optional): string

A city specified in an address
address-country(optional): string

A country specified in an address
address-postalcode(optional): string

A postal code specified in an address
address-state(optional): string

A state specified in an address
address-use(optional): string

A use code specified in an address
endpoint(optional): string

Technical endpoints providing access to services operated for the organization
identifier(optional): string

Any identifier for the organization (not the accreditation issuer's identifier)
name(optional): string

A portion of the organization's name or alias
partof(optional): string

An organization of which this organization forms a part
phonetic(optional): string

A portion of the organization's name using some kind of phonetic matching algorithm
type(optional): string

A code for the type of organization

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Organization

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

Nested Schema : Organization

Type: object

Show Source

address: array address

Minimum Number of Items: 1

Unique Items Required: true
alias: array alias
endpoint: array endpoint

Minimum Number of Items: 1

Unique Items Required: true
id: string

Minimum Length: 1
meta: object Account_meta
name: string

Minimum Length: 1
resourceType: string

Minimum Length: 1
telecom: array telecom

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text

{
    "type":"object",
    "required":[
        "address",
        "alias",
        "endpoint",
        "id",
        "meta",
        "name",
        "resourceType",
        "telecom",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "name":{
            "type":"string",
            "minLength":1
        },
        "alias":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_identifier"
            },
            "minItems":1
        },
        "address":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Organization_address"
            },
            "minItems":1
        },
        "endpoint":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Account_coverage"
            },
            "minItems":1
        },
        "meta":{
            "$ref":"#/definitions/Account_meta"
        }
    },
    "description":""
}

Nested Schema : address

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Organization_address

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

Nested Schema : alias

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : endpoint

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Account_identifier

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

Type: object

Show Source

city: string

Minimum Length: 1
country: string

Minimum Length: 1
line(optional): array line
postalCode: string

Minimum Length: 1
state: string

Minimum Length: 1

{
    "required":[
        "city",
        "country",
        "postalCode",
        "state"
    ],
    "properties":{
        "line":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "city":{
            "type":"string",
            "minLength":1
        },
        "state":{
            "type":"string",
            "minLength":1
        },
        "postalCode":{
            "type":"string",
            "minLength":1
        },
        "country":{
            "type":"string",
            "minLength":1
        }
    }
}

Nested Schema : line

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

Nested Schema : items

Type: object

Show Source

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

Nested Schema : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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