Browse across a resource includes

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

partitionKey

string

required

collectionKey

string

required

Key of the collection.

resourceId

string

required

The unified resource id.

Body

application/json

Parameters to initiate or continue a browse includes session. To initiate a session, provide the list of includes to browse and optionally the number of results to return per page. To continue a session, provide the cursor returned from a previous response.

cursor

string

The cursor representing the current BrowseIncludes session.

includes

string[]

The list of includes to browse. It can be used to include only a relationship (e.g. worksAt) or a relationship and the targeted resource (e.g. worksAt.clinic).

perPage

integer

The number of results to return per batch. Defaults to 100.

Required range: 1 <= x <= 1000

Response

A successful response containing the first batch of results and a cursor to continue browsing. 5 minutes after the request, the cursor will expire and a 404 error will be returned if you try to continue browsing.

hits

object[]

required

Show child attributes

hits.id

string

required

The unique identifier of the relationship. This is a key with the shape {fromID}.{toID}.

hits.type

string

required

hits.from

object

required

Show child attributes

hits.from.id

string

required

hits.from.type

string

required

hits.to

object

required

Show child attributes

hits.to.id

string

required

hits.to.type

string

required

hits.data

object

required

hits.meta

object

Show child attributes

hits.meta.createdAt

string<date-time>

Instant of creation of the resource.

hits.meta.identifier

object[]

Identifiers of the resource. Note: Combination of source, value and use must be unique.

Show child attributes

hits.meta.identifier.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

hits.meta.identifier.system

string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

hits.meta.identifier.value

string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

hits.meta.identifier.use

string

The purpose of this identifier.

hits.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

hits.meta.identifier.period.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

hits.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

hits.meta.identifier.period.end

string

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

hits.meta.source

string

The source of the resource.

hits.meta.updatedAt

string<date-time>

Last update of the resource.

hits.targetResource

object

Show child attributes

hits.targetResource.id

string

required

Id of the resource.

hits.targetResource.type

string

required

Type of the resource.

hits.targetResource.data

object

required

Dynamic data attributes, based on the resource type.

hits.targetResource.meta

object

Show child attributes

hits.targetResource.meta.createdAt

string<date-time>

Instant of creation of the resource.

hits.targetResource.meta.identifier

object[]

Identifiers of the resource. Note: Combination of source, value and use must be unique.

Show child attributes

hits.targetResource.meta.identifier.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

hits.targetResource.meta.identifier.system

string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

hits.targetResource.meta.identifier.value

string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

hits.targetResource.meta.identifier.use

string

The purpose of this identifier.

hits.targetResource.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

hits.targetResource.meta.identifier.period.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

hits.targetResource.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

hits.targetResource.meta.identifier.period.end

string

hits.targetResource.meta.source

string

The source of the resource.

hits.targetResource.meta.updatedAt

string<date-time>

Last update of the resource.

hits.targetResource.contained

object

Resources contained in this top-level resource. Contained resources exists only within the context of this top-level resource.

Show child attributes

hits.targetResource.contained.{key}

object[]

Show child attributes

hits.targetResource.contained.{key}.id

string

required

hits.targetResource.contained.{key}.type

string

required

Type of the resource.

hits.targetResource.contained.{key}.data

The dynamic attributes based on the resource type · object

required

hits.targetResource.contained.{key}.meta

object

Show child attributes

hits.targetResource.contained.{key}.meta.createdAt

string<date-time>

Instant of creation of the resource.

hits.targetResource.contained.{key}.meta.identifier

object[]

Identifiers of the resource. Note: Combination of source, value and use must be unique.

Show child attributes

hits.targetResource.contained.{key}.meta.identifier.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

hits.targetResource.contained.{key}.meta.identifier.system

string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

hits.targetResource.contained.{key}.meta.identifier.value

string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

hits.targetResource.contained.{key}.meta.identifier.use

string

The purpose of this identifier.

hits.targetResource.contained.{key}.meta.identifier.period

object

Time period when identifier was/is in use.

Show child attributes

hits.targetResource.contained.{key}.meta.identifier.period.id

string

Unique id for the property within a resource (for internal references). This may be any string value that does not contain spaces.

hits.targetResource.contained.{key}.meta.identifier.period.start

string

The start of the period. The boundary is inclusive.

hits.targetResource.contained.{key}.meta.identifier.period.end

string

hits.targetResource.contained.{key}.meta.source

string

The source of the resource.

hits.targetResource.contained.{key}.meta.updatedAt

string<date-time>

Last update of the resource.

hits.targetResource.relativeIdentities

object

The relative identities associated with this resource.

Show child attributes

hits.targetResource.relativeIdentities.{key}

object[]

Show child attributes

hits.targetResource.relativeIdentities.{key}.id

string

required

The logical identifier.

hits.targetResource.relativeIdentities.{key}.data

object

required

The data contains all of the differentiator properties for this relative identity.

hits.targetResource.relativeIdentities.{key}.legacyIds

string[]

The legacy ids assigned to this relative identity. Legacy ids are old identifiers that were used in the legacy system to identity this set of differentiator values.

AI Endpoints

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Browse across a resource includes

Authorizations

Path Parameters

Body

Response