Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

Excerpt

The HSPC has adopted portions of the FHIR RESTful service specification for reading, writing and searching for clinical data. Details of the FHIR RESTful services specification can be found here:

 

http://www.hl7.org/implement/standards/fhir/http.html

RESTful API 
Anchor
RESTful API
RESTful API

The following describes the RESTful services which are available for all supported FHIR resources. The basic CRUD operations (Create, Retrieve, Update, Delete) are supported as well as search. For details on supported query parameters, refer to the Query Capabilities links in the table above.

...

Details of the FHIR RESTful services specification for sorting and paging result sets can be found here: http://www.hl7.org/implement/standards/fhir/search.html#sort.

ParameterQualifiersNotes
_sortasc, desc_sort is used to sort a result set on a specified parameter. Qualifiers asc and desc indicate ascending or descending. Ex. _sort:asc=name
_countna_count is used to specify the number of results to be returned to the client. The result set will contain links to allow the client to request subsequent pages.
pagena

page is used for paging through a result set. URLs containing the page parameter are returned by the server along with result sets. The client should not create URLs containing the page parameter.