HDR FHIR API

GET Person Resource Bundle

get

/oracle-fhir-server/fhir/Person

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

Request

Query Parameters

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

The ID of the resource
_language(optional): string

The language of the resource
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
birthdate(optional): string(date)

The person's date of birth
email(optional): string

A value in an email contact
gender(optional): string

The gender of the person
identifier(optional): string

A person Identifier
link(optional): string

Any link has this Patient, Person, RelatedPerson or Practitioner reference
name(optional): string

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text
organization(optional): string

The organization at which this person record is being managed
patient(optional): string

The Person links to this Patient
phone(optional): string

A value in a phone contact
phonetic(optional): string

A portion of name using some kind of phonetic matching algorithm
practitioner(optional): string

The Person links to this Practitioner
relatedperson(optional): string

The Person links to this RelatedPerson
telecom(optional): string

The value in any kind of contact

Response

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object Person

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

Nested Schema : Person

Type: object

Show Source

active: boolean
address: array address

Minimum Number of Items: 1

Unique Items Required: true
birthDate: string

Minimum Length: 1
gender: string

Minimum Length: 1
id: string

Minimum Length: 1
identifier: array identifier

Minimum Number of Items: 1

Unique Items Required: true
link: array link

Minimum Number of Items: 1

Unique Items Required: true
meta: object Account_meta
name: array name

Minimum Number of Items: 1

Unique Items Required: true
resourceType: string

Minimum Length: 1
telecom: array telecom

Minimum Number of Items: 1

Unique Items Required: true
text: object Account_text

{
    "type":"object",
    "required":[
        "active",
        "address",
        "birthDate",
        "gender",
        "id",
        "identifier",
        "link",
        "meta",
        "name",
        "resourceType",
        "telecom",
        "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/Person_identifier"
            },
            "minItems":1
        },
        "name":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Patient_name"
            },
            "minItems":1
        },
        "telecom":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_telecom"
            },
            "minItems":1
        },
        "gender":{
            "type":"string",
            "minLength":1
        },
        "birthDate":{
            "type":"string",
            "minLength":1
        },
        "address":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Person_address"
            },
            "minItems":1
        },
        "active":{
            "type":"boolean"
        },
        "link":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Person_link"
            },
            "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 Person_address

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

Nested Schema : identifier

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Person_identifier

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

Nested Schema : link

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Person_link

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Patient_name

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

Nested Schema : telecom

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_telecom

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

Type: object

Show Source

city: string

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

Minimum Length: 1
state: string

Minimum Length: 1
use: string

Minimum Length: 1

{
    "required":[
        "city",
        "postalCode",
        "state",
        "use"
    ],
    "properties":{
        "use":{
            "type":"string",
            "minLength":1
        },
        "line":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        },
        "city":{
            "type":"string",
            "minLength":1
        },
        "state":{
            "type":"string",
            "minLength":1
        },
        "postalCode":{
            "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 : Person_identifier

Type: object

Show Source

assigner(optional): object AuditEvent_source_observer
period(optional): object Contract_period
system: string

Minimum Length: 1
type(optional): object Basic_code
use: string

Minimum Length: 1
value: string

Minimum Length: 1

{
    "required":[
        "system",
        "use",
        "value"
    ],
    "properties":{
        "use":{
            "type":"string",
            "minLength":1
        },
        "type":{
            "$ref":"#/definitions/Basic_code"
        },
        "system":{
            "type":"string",
            "minLength":1
        },
        "value":{
            "type":"string",
            "minLength":1
        },
        "period":{
            "$ref":"#/definitions/Contract_period"
        },
        "assigner":{
            "$ref":"#/definitions/AuditEvent_source_observer"
        }
    }
}

Nested Schema : AuditEvent_source_observer

Type: object

Show Source

display: string

Minimum Length: 1

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

Nested Schema : Contract_period

Type: object

Show Source

start: string

Minimum Length: 1

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

Nested Schema : Basic_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/ActivityDefinition_code"
            },
            "minItems":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
        }
    }
}

Nested Schema : Person_link

Type: object

Show Source

target(optional): object Account_subject

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

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

Type: object

Show Source

family: string

Minimum Length: 1
given(optional): array given
use: string

Minimum Length: 1

{
    "required":[
        "family",
        "use"
    ],
    "properties":{
        "use":{
            "type":"string",
            "minLength":1
        },
        "family":{
            "type":"string",
            "minLength":1
        },
        "given":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                }
            }
        }
    }
}

Nested Schema : given

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

Type: object

Show Source

system: string

Minimum Length: 1
use: string

Minimum Length: 1
value: string

Minimum Length: 1

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