Jump to

• Request
• Response

Get a list of related persons

get

/RelatedPerson

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves a list of related persons that meet the supplied query parameters.

Request

Query Parameters

• _count: integer
  Minimum Value: 1

  Maximum Value: 128

  The maximum number of results per page.

  Default Value: 50
• _id: string
  The logical resource ID.
• _lastUpdated: string
  One instant or date or a lower and upper comparison range.
• _revinclude: string
  The inclusion of related Provenance resources whose target is a returned related person.

  Allowed Values: [ "Provenance:target" ]
• identifier: string
  One system|value identifier token.
• name: string
  The name prefix.
• patient: string
  One patient ID or Patient/id reference.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Back to Top

Response

200 Response

The successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleEntryForRelatedPerson"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object BundleEntryForRelatedPerson

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleEntryForRelatedPerson"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : BundleEntryForRelatedPerson

Type: object

Show Source

• fullUrl(required): string
• resource(required): resource
• search(required): object BundleEntrySearch

{
    "type":"object",
    "required":[
        "fullUrl",
        "resource",
        "search"
    ],
    "additionalProperties":false,
    "properties":{
        "fullUrl":{
            "type":"string"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/RelatedPerson"
                },
                {
                    "$ref":"#/components/schemas/ProvenanceForRelatedPerson"
                },
                {
                    "$ref":"#/components/schemas/OperationOutcome"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

• object RelatedPerson
  The Oracle US Core RelatedPerson returned by read and search operations.
• object ProvenanceForRelatedPerson
  Additional Properties Allowed: true
• object OperationOutcome
  The FHIR OperationOutcome.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/RelatedPerson"
        },
        {
            "$ref":"#/components/schemas/ProvenanceForRelatedPerson"
        },
        {
            "$ref":"#/components/schemas/OperationOutcome"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

• mode: string

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

Nested Schema : RelatedPerson

Type: object

The Oracle US Core RelatedPerson returned by read and search operations.

Show Source

• active(required): boolean
  Allowed Values: [ true ]
• address: array address
• birthDate: string (date)
• communication: array communication
• gender: string
  Allowed Values: [ "male", "female", "other", "unknown" ]
• id(required): string
• identifier: array identifier
• meta: object meta
• name: array name
• patient(required): object ReferenceForRelatedPerson
• relationship: array relationship
• resourceType(required): string
  Allowed Values: [ "RelatedPerson" ]
• telecom: array telecom
• text(required): object Narrative

{
    "type":"object",
    "description":"The Oracle US Core RelatedPerson returned by read and search operations.",
    "required":[
        "resourceType",
        "id",
        "text",
        "active",
        "patient"
    ],
    "additionalProperties":false,
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "RelatedPerson"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "identifier":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Identifier"
            }
        },
        "active":{
            "type":"boolean",
            "enum":[
                true
            ]
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForRelatedPerson"
        },
        "relationship":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConceptForRelatedPerson"
            }
        },
        "name":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HumanName"
            }
        },
        "telecom":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ContactPoint"
            }
        },
        "gender":{
            "type":"string",
            "enum":[
                "male",
                "female",
                "other",
                "unknown"
            ]
        },
        "birthDate":{
            "type":"string",
            "format":"date"
        },
        "address":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Address"
            }
        },
        "communication":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CommunicationForRelatedPerson"
            }
        }
    }
}

Nested Schema : ProvenanceForRelatedPerson

Type: object

Additional Properties Allowed: true

Show Source

• resourceType(required): string
  Allowed Values: [ "Provenance" ]

{
    "type":"object",
    "required":[
        "resourceType"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Provenance"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : address

Type: array

Show Source

• Array of: object Address

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Address"
    }
}

Nested Schema : communication

Type: array

Show Source

• Array of: object CommunicationForRelatedPerson

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CommunicationForRelatedPerson"
    }
}

Nested Schema : identifier

Type: array

Show Source

• Array of: object Identifier

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Identifier"
    }
}

Nested Schema : meta

Type: object

Show Source

• lastUpdated: string (date-time)
• security: array security
• versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : name

Type: array

Show Source

• Array of: object HumanName

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/HumanName"
    }
}

Nested Schema : ReferenceForRelatedPerson

Type: object

Show Source

• display: string
• reference(required): string

{
    "type":"object",
    "required":[
        "reference"
    ],
    "additionalProperties":false,
    "properties":{
        "reference":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : relationship

Type: array

Show Source

• Array of: object CodeableConceptForRelatedPerson

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConceptForRelatedPerson"
    }
}

Nested Schema : telecom

Type: array

Show Source

• Array of: object ContactPoint

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ContactPoint"
    }
}

Nested Schema : Narrative

Type: object

Show Source

• div: string
  The XHTML narrative content.
• status: string
  The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : Address

Type: object

Show Source

• city: string
• country: string
• district: string
• line: array line
• period: object Period
• postalCode: string
• state: string
• text: string
• type: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "line":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "city":{
            "type":"string"
        },
        "district":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : line

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Period

Type: object

Show Source

• end: string
• start: string

{
    "type":"object",
    "properties":{
        "start":{
            "type":"string"
        },
        "end":{
            "type":"string"
        }
    }
}

Nested Schema : CommunicationForRelatedPerson

Type: object

Show Source

• language(required): object CodeableConcept
• preferred: boolean

{
    "type":"object",
    "required":[
        "language"
    ],
    "additionalProperties":false,
    "properties":{
        "language":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "preferred":{
            "type":"boolean"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• period: object Period
• system: string
• type: object CodeableConcept
• use: string
• value: string

{
    "type":"object",
    "properties":{
        "use":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "system":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : security

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : HumanName

Type: object

Show Source

• family: string
• given: array given
• period: object Period
• prefix: array prefix
• suffix: array suffix
• text: string
• use: string

{
    "type":"object",
    "additionalProperties":false,
    "properties":{
        "use":{
            "type":"string"
        },
        "text":{
            "type":"string"
        },
        "family":{
            "type":"string"
        },
        "given":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "prefix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "suffix":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : given

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : prefix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : suffix

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : CodeableConceptForRelatedPerson

Type: object

Show Source

• coding: array coding
• extension: array extension
• id: string
• text: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        },
        "extension":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExtensionForRelatedPerson"
            }
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : extension

Type: array

Show Source

• Array of: object ExtensionForRelatedPerson

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExtensionForRelatedPerson"
    }
}

Nested Schema : ExtensionForRelatedPerson

Type: object

Show Source

• url: string (uri)
• valuePeriod: object Period

{
    "type":"object",
    "properties":{
        "url":{
            "type":"string",
            "format":"uri"
        },
        "valuePeriod":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : ContactPoint

Type: object

Show Source

• period: object Period
• rank: integer
• system: string
  The telecommunications form.
• use: string
• value: string
  The contact value.

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "description":"The telecommunications form."
        },
        "value":{
            "type":"string",
            "description":"The contact value."
        },
        "use":{
            "type":"string"
        },
        "rank":{
            "type":"integer"
        },
        "period":{
            "$ref":"#/components/schemas/Period"
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]

  The link relation.
• url: string
  The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

• issue: array issue
  The OperationOutcome issues.
• resourceType: string
  Allowed Values: [ "OperationOutcome" ]

  The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

• Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

• code: string
• details: object CodeableConcept
• diagnostics: string
• expression: array expression
• severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
  The terminology codings or data-absent-reason coding.
• id: string
• text: string
  The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string
• userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Back to Top