Argonaut User Facing Patient List
0.1.0 - CI Build

Argonaut User Facing Patient List - Local Development build (v0.1.0). See the Directory of published versions

OperationDefinition: Group Get Page Operation

GroupGetPageOperation

OPERATION: GroupGetPageOperation

The official URL for this operation definition is: 

http://www.fhir.org/guides/argonaut/patient-list/OperationDefinition/getpage

The Group resource can contain a large number of member elements. When it is large, it may pose a challenge to a Client to efficiently fetch and process it. To work around this issue, the $getpage operation returns a List or Group with just a subset of its member elements. It is an instance level operation that uses the input parameters offset and count to specify the subset.

URL: [base]/Group/[id]/$getpage

Parameters

UseNameCardinalityTypeBindingDocumentation
INoffset0..1integer

Offset is the starting 0 based index (default = 0) of the Group.member element array if a Group subset is desired.

INcount0..1integer

Count is the number Group.member elements that should be provided if a Group subset is desired. The count defaults to the Server's existing paging limit for the results of a search or interaction.

OUTreturn1..1Group

The Group resource with the subset of Group.member elements that is desired

  • This operation uses the following Syntax:

    [Base]/Group/[id]/$getPage?offset=X\&count=Y{\&...}

  • Servers are not obliged to support this operation, but if they do, they SHALL support both the offset and count parameters.

  • The same as when using as when using _summary, Servers SHOULD mark the Group resource with the tag "SUBSETTED" to ensure that the incomplete resource is not accidentally used to overwrite a complete resource.