HDR FHIR API

GET RelatedPerson Resource Bundle

get

/oracle-fhir-server/fhir/RelatedPerson

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

Indicates if the related person record is 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
birthdate(optional): string(date)

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

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

Gender of the related person
identifier(optional): string

An Identifier of the RelatedPerson
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
patient(optional): string

The patient this related person is related to
phone(optional): string

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

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

The relationship between the patient and the 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 RelatedPerson

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

Nested Schema : RelatedPerson

Type: object

Show Source

address: array address

Minimum Number of Items: 1

Unique Items Required: true
gender: string

Minimum Length: 1
id: string

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

Minimum Number of Items: 1

Unique Items Required: true
patient: object Account_coverage
period: object Contract_period
photo: array photo

Minimum Number of Items: 1

Unique Items Required: true
relationship: array relationship

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":[
        "address",
        "gender",
        "id",
        "meta",
        "name",
        "patient",
        "period",
        "photo",
        "relationship",
        "resourceType",
        "telecom",
        "text"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "minLength":1
        },
        "id":{
            "type":"string",
            "minLength":1
        },
        "text":{
            "$ref":"#/definitions/Account_text"
        },
        "patient":{
            "$ref":"#/definitions/Account_coverage"
        },
        "relationship":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ActivityDefinition_jurisdiction"
            },
            "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
        },
        "address":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Person_address"
            },
            "minItems":1
        },
        "photo":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Contract_contentAttachment"
            },
            "minItems":1
        },
        "period":{
            "$ref":"#/definitions/Contract_period"
        },
        "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 : 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 : Account_coverage

Type: object

Show Source

reference: string

Minimum Length: 1

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

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object Contract_contentAttachment

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

Nested Schema : relationship

Type: array

Minimum Number of Items: 1

Unique Items Required: true

Show Source

Array of: object ActivityDefinition_jurisdiction

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

Type: object

Show Source

contentType: string

Minimum Length: 1
url: string

Minimum Length: 1

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

Nested Schema : ActivityDefinition_jurisdiction

Type: object

Show Source

coding(optional): array coding

Minimum Number of Items: 1

Unique Items Required: true

{
    "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 : 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
        }
    }
}